Create a new cancellation

Create a new cancellation for a program.

Business Rules:

  • The program must not be archived.
  • The start date must fall within the program's start and end date range.
  • The end date (if provided) must not be before start.
  • The end date (if provided) must also fall within the program's date range.
  • Past cancellations are allowed — start can be a date in the past as long as it is within the program's date range.
  • If the program is already published, creating a cancellation will automatically cancel all existing events that fall within the specified date range.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The programId of the program

Body Params
string
required

The name/reason for the cancellation

date
required

The start date of the cancellation in YYYY-MM-DD format (inclusive). Must be within the program's date range.

date

The end date of the cancellation in YYYY-MM-DD format (inclusive). If not provided, the cancellation applies to the single day specified by start.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json