Proposals/Confirmed Bookings

Cancel an event

Cancel an event with an optional reason and option to send cancellation messages to contacts.

Required permission: assigned_event_write or unassigned_event_write

put/api/v1/events/{event_id}/cancel

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/events/{event_id}/cancel
  • Auth: none declared. Required headers: Api-Key

Path parameters

event_idinteger required

Event ID

Headers

Api-Keystring required

Your Integration Key

Request body

cancel_reasonstring

Reason for cancellation

send_cancellation_messagesboolean

Send cancellation messages to contacts

Response

event canceled

Changes

No recorded changes to this operation across all 2 revisions of this API.