Update a scheduling task
Updates the supplied assignee, urgency, queue, tags, debrief requirement, or meeting location for a scheduling task. Omitted fields are preserved; null clears the assignee, queue, or meeting location, while supplying tags replaces the task’s tag list. An empty PATCH body is rejected.
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
an employee ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.
^(?:emp_)?(?:[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})$"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
Replaces the urgency flag when supplied; omit to preserve it.
a task queue ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.
^(?:que_)?(?:[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})$"que_a1b2c3d4e5f64789a1b2c3d4e5f64789"
Tags must already exist in the organization; unknown tags are rejected.
Replaces whether a debrief is required when supplied; omit to preserve it.
Replaces the meeting location. Omit to preserve; null clears it.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
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.