Cancel BETA

Required plan: Scheduler

Description #

Cancels a Scheduling Request using a Cronofy Account.

Authentication is with either:

  1. an access token for the Organizational Unit, created by authorizing an application for an Organizational Unit scope like organizational_unit_scheduler
  2. the client_secret of an Internal Application linked to the Organizational Unit.

The API also supports the sub of an Account connected to the Organizational Unit in the Cronofy-Impersonate header.

URL format #

{data_center_url}/v1/scheduling_requests/cancel

Example Request #

POST /v1/scheduling_requests/cancel HTTP/1.1
Host: {data_center_url}
Authorization: Bearer {API_KEY}
Content-Type: application/json; charset=utf-8

{
  "scheduling_request_id": "srq_b34a4f5e08f68c162911a696"
}

Example Response #

HTTP/1.1 202 Accepted

Request Parameters #

data_center_url required

The URL for the data center you want to communicate with. Possible choices are:

  • api-au.cronofy.com - 🇦🇺 Australia
  • api-ca.cronofy.com - 🇨🇦 Canada
  • api-de.cronofy.com - 🇩🇪 Germany
  • api-sg.cronofy.com - 🇸🇬 Singapore
  • api-uk.cronofy.com - 🇬🇧 United Kingdom
  • api.cronofy.com - 🇺🇸 United States

Find out more about Cronofy's data centers.

scheduling_request_id required  #

Cronofy’s unique identifier for the Scheduling Request String.