API ReferenceHolidays

Deletes a holiday definition and its occurrences and assignments (cascade in the database).

Removes the definition and all child occurrence and assignment rows. Returns HTTP 404 if the definition does not exist or is not in the workspace.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"

Public identifier of the holiday to delete (GUID).

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Response

Success
errorobject or nullOptional
If the API call failed, this will contain information about the error that occurred.
successbooleanOptionalRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanOptionalRead-only
True if the API call failed.
statusCodeenumOptional
The HTTP code of the response.