ApptBookingUrlConfig

Represents a collection of fields used to set up the URL paths for appointment scheduling endpoints. This object is available in API version 52.0 and later.

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.

Important

Supported SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

AdditionalHeaders

Type: textarea
Properties: Create, Nillable, Update
Description: Specify headers added to the HTTP request. The format is: key:value;key:value;key:value;

ApptBookingConfigId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The appointment scheduling config associated with the record.

This field is a relationship field.
Relationship Name: ApptBookingConfig
Relationship Type: Lookup
Refers To: ApptBookingConfig

DeveloperName

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.

Note

EndpointName

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: Specifies the name of the endpoint to be called.
Possible values:
- CANCEL_APPOINTMENT—Cancel Appointment
- CREATE_APPOINTMENT—Create Appointment
- CREATE_PATIENT—Create Patient
- FIND_SLOTS—Find Slots
- GET_APPOINTMENT—Get Appointment
- GET_SLOT_STATUS—Get Slot Status

Language

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The language of the Appointment Booking URL Configuration.
Possible values:
- da—Danish
- de—German
- en_US—English
- es—Spanish
- es_MX—Spanish (Mexico)
- fi—Finnish
- fr—French
- it—Italian
- ja—Japanese
- ko—Korean
- nl_NL—Dutch
- no—Norwegian
- pt_BR—Portuguese (Brazil)
- 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 UI label of Appointment Booking URL Configuration.

UrlPath

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The URL path for the endpoint.