For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomepageProduct HelpLog inTry for Free
Developers HomeAPI ReferenceMCP
Developers HomeAPI ReferenceMCP
  • Getting Started
    • Introduction
    • Authentication with API Keys
    • Authentication with OAuth
    • API Clients
    • Pagination
    • Specifying Fields
    • Filter Parameters
    • HTTP Response Codes
    • Rate Limits
    • Timezone Offsets
    • Rich Text Fields
    • Changelog
  • CRM Core
    • Leads
    • Contacts
    • Opportunities
    • Tasks
    • Files
    • Custom Objects
    • Comments
  • Activities
    • Activities
    • Notes
    • Calls
    • Emails
    • Email Threads
    • WhatsApp Messages
    • Meetings
    • Custom Activities
    • Creations
    • Form Submissions
    • Lead Status Changes
    • Opportunity Status Changes
    • Lead Merges
    • Task Completions
  • Events & Webhooks
    • Webhooks
    • Events
  • Search & Reporting
    • Advanced Filtering
    • Smart Views
    • Reporting
  • Automation & Bulk Actions
    • Sequences (Workflows)
    • Bulk Actions
    • Exports
    • AI Field Enrichment
  • CRM Configuration
    • Custom Fields
    • Custom Activity Types
    • Custom Object Types
    • Pipelines
    • Opportunity Statuses
    • Lead Statuses
    • Integration Links
    • Forms
  • Communication Configuration
    • Email Templates
    • SMS Templates
    • Outcomes
    • Playbooks
    • Scheduling Links Guide
    • Scheduling Links
      • GETList User Scheduling Links
      • POSTCreate a User Scheduling Link
      • POSTCreate or update a Scheduling Link via OAuth
      • DELDelete a User Scheduling Link via OAuth integration
      • GETFetch a User Scheduling Link
      • PUTUpdate a User Scheduling Link
      • DELDelete a User Scheduling Link
      • GETList Shared Scheduling Links
      • POSTCreate a Shared Scheduling Link
      • GETFetch a Shared Scheduling Link
      • PUTUpdate a Shared Scheduling Link
      • DELDelete a Shared Scheduling Link
      • POSTMap a Shared Scheduling Link
      • POSTUnmap a Shared Scheduling Link
    • Connected Accounts
    • Send As
    • Unsubscribed Emails
    • Phone Numbers
    • Blocked Phone Numbers
    • Dialers
  • Users & Organizations
    • Users
    • Organizations
    • Memberships
    • Roles
    • Groups
Close

Product

OverviewCommunicationAutomationIntegrationsReportingSMSCallingSecurityForms

Pricing & Use Cases

PricingClose vs Other CRMsCustomer Stories

Resources

Sales BlogSales ResourcesSales GuidesWebinarsOn-Demand DemoSales Tools

Company

AboutCareersPartner with CloseBrand GuidelinesTermsPrivacyGDPRCCPA

Get Help

+1-833-GO-CLOSEHelp CenterDownload the Close AppProduct UpdatesSystem Status
LogoLogo
HomepageProduct HelpLog inTry for Free
Communication Configuration

Scheduling Links

Close users can embed scheduling links in their communications sent through Close
||View as Markdown|
Was this page helpful?
Edit this page
Previous

Scheduling Links

Next

List User Scheduling Links

Built with

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

Close supports three types of 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 Close.
  • url - the external URL to the scheduling link.
  • description - a description, displayed in Close.

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 Close).
  • duration_in_minutes - the length of meetings scheduled with this link, in minutes (displayed in Close).