---
schema_version: "1"
id: 9ed6223c95ff09fd155dd88f6d6c66344479696b7b9d90ee27f0e085c0a1f872
title: Waitlist
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/service-cloud/salesforce-scheduler-dev-guide/guides/salesforce-scheduler/objects/sforce-api-objects-waitlist.md
canonical_url: https://developer.salesforce.com/docs/service/salesforce-scheduler-dev-guide/guide/sforce-api-objects-waitlist.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6db10b06e136d1a5da73399314978128af11b4febd48ffde83cc7b48f194a01b
products:
  - Salesforce Scheduler Developer Guide
  - Service Cloud Developer Content
---

# Waitlist

Represents a queue to which drop in customers who visit the branch without an already scheduled appointment are added. This object is available in API version 58.0 and later.

## Supported Calls

`create()`, `delete()`, `describeLayout()`, `describeSObjects()`, `getDeleted()`, `getUpdated()`, `query()`, `retrieve()`, `search()`, `undelete()`, `update()`, `upsert()`

## Special Access Rules

Salesforce Scheduler must be enabled.

## Usage

Use waitlists to manage drop in customers. You can create multiple waitlists for a service territory. Depending on your business set up, assign work type groups and service resources to a waitlist. When customers visit the branch, the greeter can check them in to a specific waitlist based on the reason they’re visiting the branch. Depending on the availability of service resources on a particular day, you can choose to enable or disable a waitlist.

## Fields

### Description

-   **Type**: textarea
-   **Properties**: Create, Nillable, Update
-   **Description**: The description of the waitlist.

### IsActive

-   **Type**: boolean
-   **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
-   **Description**: Indicates whether the waitlist is available to add drop in customers (`true`) or not (`false`).
-   **Default value**: `false`

### LastReferencedDate

-   **Type**: dateTime
-   **Properties**: Filter, Nillable, Sort
-   **Description**: The date when the waitlist was last modified. Its label in the user interface is Last Modified Date.

### LastViewedDate

-   **Type**: dateTime
-   **Properties**: Filter, Nillable, Sort
-   **Description**: The date when the waitlist was last viewed.

### Name

-   **Type**: string
-   **Properties**: Create, Filter, Group, idLookup, Sort, Update
-   **Description**: The name of the waitlist.

### OwnerId

-   **Type**: reference
-   **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
-   **Description**: The owner of the waitlist. This field is a polymorphic relationship field.
-   **Relationship Name**: Owner
-   **Relationship Type**: Lookup
-   **Refers To**: Group, User

### ServiceTerritoryId

-   **Type**: reference
-   **Properties**: Create, Filter, Group, Nillable, Sort
-   **Description**: The ID of the service territory to which the waitlist belongs. This field is a relationship field.
-   **Relationship Name**: ServiceTerritory
-   **Relationship Type**: Lookup
-   **Refers To**: ServiceTerritory

### Type

-   **Type**: picklist
-   **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
-   **Description**: Specifies the appointment type.
-   **Default value**: `DropIn`
-   **Possible values**:

    -   `DropIn`
    -   `Queued`

## Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

[WaitlistFeed](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object.

[WaitlistHistory](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object.

[WaitlistOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object.

[WaitlistShare](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_associated_objects_share.htm): Sharing is available for the object.