Disable

Description #

Disables a Real Time Scheduling link. You can only disable a link which has not been completed. Anyone visiting the link after it has been disabled will see a message of your choosing.

URL format #

api.cronofy.com/v1/real_time_scheduling/{id}/disable HTTP/1.1

Example Request #

POST /v1/real_time_scheduling/{id}/disable HTTP/1.1
Host: api.cronofy.com
Authorization: Bearer {API_KEY}
Content-Type: application/json; charset=utf-8

{
  "display_message": "Let's hold off until next month."
}

Request parameters #

id required  #

The Cronofy identifier for the Real Time Scheduling link, a String.

display_message required  #

A String message which will be displayed to anyone visiting the link after it has been disabled. The maximum length accepted is 500 characters.

HTML is not supported, but white-space formatting (e.g. line-breaks and paragraphs) is preserved.

Example Response #

HTTP/1.1 200 OK

{
  "real_time_scheduling": {
    "real_time_scheduling_id": "sch_4353945880944395",
    "url": "{REAL_TIME_SCHEDULING_URL}",
    "event": {...},
    "status": "disabled"
  }
}

The resulting state of the Real Time Scheduling link, equivalent to the Status endpoint response.

Search