Email SupportCall Us Go to Close

User Scheduling Links

Close users can embed scheduling links in their communications sent through Close.

Close supports three types of User Scheduling Links (identified by their source attribute):

  • MANUAL - user created via Close application or /scheduling_link/ endpoints
  • THIRD_PARTY - created and managed by an OAuth application, via the /scheduling_link/integration/ endpoints
  • CALENDLY - created and managed by Close's first-party support for Calendly

Each scheduling link has the following editable attributes:

  • name - a name for the scheduling link, displayed in the Close application.
  • url - the external URL to the scheduling link.
  • description - a description for the scheduling link, displayed in the Close application.

Scheduling links of source: "THIRD_PARTY" also have the following editable attributes. Note: these attributes may be null or populated for links having source: "CALENDLY" or source: "MANUAL".

  • source_id - the ID at the source. I.e., the integrating application's identifier for the scheduling link.
  • source_type - a short descriptor identifying the type of scheduling link (displayed in the Close application).
  • duration_in_minutes - the length of meetings scheduled with this link, in minutes (displayed in the Close application).

GET /scheduling_link/

POST /scheduling_link/

GET /scheduling_link/{id}/

PUT /scheduling_link/{id}/

DELETE /scheduling_link/{id}/

POST /scheduling_link/integration/

Please note that only OAuth apps can perform this operation. Using API key will result in an error. See Authentication with OAuth for more information.

Create or update a user scheduling link, managed by your application. Uses the integration-provided source_id field to identify and merge duplicate resources created by the same OAuth Application. If a scheduling link created by your OAuth application with the specified source_id does not exist, a new one will be created. Otherwise, the scheduling link resource will be updated. Requires authentication via OAuth.

DELETE /scheduling_link/integration/{source_id}/

Please note that only OAuth apps can perform this operation. Using API key will result in an error. See Authentication with OAuth for more information.

Uses the source_id field to identify and delete the specified User Scheduling Link created by your OAuth Application.