--- schema_version: "1" id: 6e860c8fea544f346049dcb766ba75ad070c28d10c82fa126dae2f120f033524 title: AppointmentSchedulingPolicy collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_appointmentschedulingpolicy.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_appointmentschedulingpolicy.htm source_site: developer.salesforce.com content_type: documentation content_hash: 8007dce5b4f4c369bc87f63477950f40ee3161cab86cfe13d9de8a014f4ea3a6 description: Represents a set of rules for scheduling appointments using Lightning Scheduler. This type extends the Metadata metadata type and inherits its fullName field. --- # AppointmentSchedulingPolicy Represents a set of rules for scheduling appointments using Lightning Scheduler. This type extends the Metadata metadata type and inherits its fullName field. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## File Suffix and Directory Location AppointmentSchedulingPolicy components have the suffix .policy and are stored in the appointmentSchedulingPolicies folder. ## Version AppointmentSchedulingPolicy components are available in API version 47.0 and later. ## Special Access Rules You must have the ViewSetup and CustomizeApplication user permissions to access the AppointmentSchedulingPolicy type. ## Fields
Field Name Field Type Description
appointmentAssignmentPolicy string The name of the appointment assignment policy. This field is available in API version 53.0 and later.
appointmentStartTimeInterval picklist Required. The proposed time interval in minutes between appointment start times. For example, if you 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). Valid values are:
  • 5
  • 10
  • 15
  • 20
  • 30
  • 45
  • 60
  • 90
  • 120
  • 150
  • 180
  • 240
  • 300
  • 360
  • 420
  • 480
extCalEventHandler lookup Required. 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.
isSvcTerritoryMemberShiftUsed boolean Required. Indicates whether to consider shifts of service territory members when determining the availability of service resources for appointments (true) or not (false). This field is available in API version 54.0 and later.
isSvcTerrOpHoursWithShiftsUsed boolean Required. Indicates whether to consider the intersection of shifts and service territory operating hours when determining the availability of service resources for appointments (true) or not (false). This field is available in API version 54.0 and later.
masterLabel string Required. The label for the appointment scheduling policy.
shouldCheckExternalCalendar boolean Required. Indicates whether to check the external calendar for resource availability (true) or not (false). This field is available in API version 53.0 and later.
shouldConsiderCalendarEvents boolean Required. Indicates whether to consider events on the Salesforce calendar to determine the availability of service resources to be assigned to appointments (true) or not (false).
shouldEnforceExcludedResource boolean Required. Indicates whether this appointment scheduling policy prevents excluded service resources from being assigned to appointments (true) or not (false).
shouldEnforceRequiredResource boolean Required. Indicates whether this appointment scheduling policy allows only required service resources to be assigned to appointments (true) or not (false).
shouldMatchSkill boolean Required. Indicates whether this appointment scheduling policy allows only required service resources who have certain skills to be assigned to appointments (true) or not (false).
shouldMatchSkillLevel boolean Required. Indicates whether this appointment scheduling policy allows only required service resources who have certain skills and skill levels to be assigned to appointments (true) or not (false).
shouldRespectVisitingHours boolean Required. Indicates whether this appointment scheduling policy prevents users from scheduling appointments outside of an account’s visiting hours (true) or not (false).
shouldUsePrimaryMembers boolean Required. Indicates whether this appointment scheduling policy allows only service resources who are primary members of a service territory to be assigned to appointments (true) or not (false).
shouldUseSecondaryMembers boolean Required. Indicates whether this appointment scheduling policy allows service resources who are secondary members of a service territory to be assigned to appointments (true) or not (false).
## Declarative Metadata Sample Definition The following is an example of an appointmentSchedulingPolicy component. ResourceAssignmentRule1 15 Default Appointment Scheduling Policy true true true true true false true true true The following is an example package.xml that references the previous definition. sample AppointmentSchedulingPolicy 47.0 ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).