Skip Navigation

Newer Version Available

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

AppointmentSchedulingPolicy

Represents a set of rules for scheduling appointments using Lightning Scheduler. This object is available in API version 45.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

Field	Details
AppointmentStartTimeInterval	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The proposed time interval in minutes between appointment start times. For example, set the interval to 15. Appointments can then begin at the top of the hour and at 15-minute intervals thereafter (10:00 AM, 10:15 AM, 10:30 AM, and so on). Possible values are: `5` `10` `15` `20` `30` `45` `60` `90` `120` `150` `180` `240` `300` `360` `420` `480`
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The API name of the AppointmentSchedulingPolicy object.
ExtCalEventHandlerId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of the custom Apex class that checks service resources’ external calendar events and returns the time slots where service resources are already booked. Available in API version 50.0 and later.
IsOrgDefault	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this scheduling policy is the default appointment scheduling policy for Lightning Scheduler appointments in this org.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the appointment scheduling policy. Possible values are: `Possible` values are: `da` (Danish) `de` (German) `en_US` (English) `es` (Spanish) `es_MX` (Spanish - Mexican) `fi` (Finnish) `fr` (French) `it` (Italian) `ja` (Japanese) `ko` (Korean) `nl_NL` (Dutch) `no` (Norwegian) `pt_BR` (Portuguese - Brazilian) `ru` (Russian) `sv` (Swedish) `th` (Thai) `zh_CN` (Chinese - Simplified) `zh_TW` (Chinese - Traditional)
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The label for the appointment scheduling policy.
ShouldEnforceExcludedResource	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy prevents excluded service resources from being assigned to appointments.
ShouldEnforceRequiredResource	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy allows only required service resources to be assigned to appointments.
ShouldMatchSkill	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy allows only required service resources who have certain skills to be assigned to appointments.
ShouldMatchSkillLevel	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy allows only required service resources who have certain skills and skill levels to be assigned to appointments.
ShouldRespectVisitingHours	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy prevents users from scheduling appointments outside of an account’s visiting hours.
ShouldUsePrimaryMembers	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy allows only service resources who are primary members of a service territory to be assigned to appointments.
ShouldUseSecondaryMembers	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this appointment scheduling policy allows service resources who are secondary members of a service territory to be assigned to appointments.