Newer Version Available

This content describes an older version of this product. View Latest

LocationWaitlist

Represents a queue created for a specific location. Multiple queues can be created for a single location. For example, you can have a queue for each sales agent or a standard queue and a queue for vulnerable groups. The specific party of people in a queue is represented by LocationWaitlistedParty. This object is available in API version 50.0 and later.

Supported Calls

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

Fields

Field Details
BusinessHoursId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A reference to the BusinessHours record that contains the hours the business is open.
ClosedDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The time a queue is closed.
CumulativeGuestCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The total number of guests allowed.
CumulativeGuestGroupCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The total number of groups allowed.
CurrentGuestCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The current number of guests.
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A brief description of this record.
GuestCapacity
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The total capacity of guests.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date on which the record was last viewed.
MaxPartySize
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum size of a group.
MessagingChannelId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The messaging channel ID.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the group.
OpenDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The time a queue is open.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner for this record.
PartyReminderDelayMinutes
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of minutes between when a party is notified and when they receive a reminder.
PlaceId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The location ID for this record.
ResourceCapacity
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The capacity for this resource.
ResourceOccupancyCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The occupancy count for this resource.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the queue.
Possible values are:
  • closed
  • open
  • paused