Cancel a scheduling task
Cancels a scheduling task, optionally recording a cancellation reason. Cancellation is rejected when the underlying scheduler reports a conflict. The returned task shows the resulting scheduling state.
Authorizations
API tokens are passed as Bearer tokens.
Path Parameters
a task ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.
^(?:tsk_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"tsk_a1b2c3d4e5f64789a1b2c3d4e5f64789"
Body
Optional cancellation reason; omit to cancel without a reason.
Response
Success
Canonical task ID (tsk_ followed by 32 lowercase hexadecimal UUID characters).
^tsk_[0-9a-f]{32}$"tsk_a1b2c3d4e5f64789a1b2c3d4e5f64789"
NEEDS_AVAILABILITY, WAITING_FOR_CANDIDATE, READY_TO_SCHEDULE, READY_TO_RESCHEDULE, HOLD, READY_TO_SEND_TO_CANDIDATE, SCHEDULED, COMPLETED, CANCELED, NEEDS_DEBRIEF Canonical task queue ID (que_ followed by 32 lowercase hexadecimal UUID characters).
^que_[0-9a-f]{32}$"que_a1b2c3d4e5f64789a1b2c3d4e5f64789"
ISO 8601 timestamp.
ISO 8601 timestamp.