AppointmentInvitation

Represents information about an appointment invitation that’s created for customers who can use it for booking appointments. This object is available in API version 55.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

An appointment invitation can show the availability of one or more resources represented in the Appointment Invitee object.

Fields

AppointmentTopicId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort
Description: Appointment topic that’s associated with this invitation. This field is a polymorphic relationship field.
Relationship Name: AppointmentTopic
Relationship Type: Lookup
Refers To: WorkType, WorkTypeGroup

AppointmentTopicType

Type: string
Properties: Filter, Group, Nillable, Sort
Description: Type of appointment topic that’s related to this invitation. For example, work type or work type group.

AppointmentType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort
Description: Appointment type for the appointment invitation. This field is available in API version 57.0 and later. Recommended values are: Salesforce Scheduler verifies whether the API name of a picklist value matches the name of a utility icon that Lightning Design System provides. If the names match, Salesforce Scheduler uses the icon with the same name. If the names don’t match, Salesforce Scheduler uses the default groups icon.
- groups—Group
- resource_territory—In Person
- phone_portrait—Phone
- video—Video call

BookingEndDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Date until which an appointment can be booked by using the appointment invitation URL.

BookingStartDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Date from which an appointment can be booked by using the appointment invitation URL.
Default value: current date

EngagementChannelTypeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort
Description: Engagement channel type for the appointment invitation. For example, users can choose video call as the engagement channel type when they create an appointment invitation. This field is available in API version 57.0 and later. This field is a relationship field.
Relationship Name: EngagementChannelType
Relationship Type: Lookup
Refers To: EngagementChannelType

InvitationIdentifier

Type: string
Properties: Filter, Group, Nillable, Sort
Description: Invitation URL identifier that’s used to book an appointment in a flow.

InvitationNumber

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: Auto-assigned number that identifies the appointment invitation.

InvitationUrl

Type: url
Properties: Create, Filter, Group, Nillable, Sort
Description: Appointment invitation URL that’s shared with users to book appointments.

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the invitation URL is available for a customer to book an appointment.
Default value: true

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: Date on which the appointment invitation was last modified. Its label in the user interface is Last Modified Date.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: Date on which the appointment invitation was last viewed.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Owner of the appointment invitation. 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: Service territory that’s associated with the appointment invitation. This field is a relationship field.
Relationship Name: ServiceTerritory
Relationship Type: Lookup
Refers To: ServiceTerritory

UrlExpiryDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Expiration date of the appointment invitation URL.

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.

AppointmentInvitationChangeEvent: Change events are available for the object.

AppointmentInvitationFeed: Feed tracking is available for the object.

AppointmentInvitationHistory: History is available for tracked fields of the object.

AppointmentInvitationOwnerSharingRule: Sharing rules are available for the object.

AppointmentInvitationShare: Sharing is available for the object.