Sign in

v1

latestOpenAPI 3.1.02026-07-224239180.9 KB
Scheduling Task

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.

patch/v1/tasks/{taskId}

Path parameters

taskIdstring required

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.

Example:tsk_a1b2c3d4e5f64789a1b2c3d4e5f64789

Request body

assignee_idstring nullable

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.

is_urgentboolean

Replaces the urgency flag when supplied; omit to preserve it.

queue_idstring nullable

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.

tagsstring[]

Tags must already exist in the organization; unknown tags are rejected.

is_debrief_requiredboolean

Replaces whether a debrief is required when supplied; omit to preserve it.

Example request

{
  "assignee_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "queue_id": "que_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "meeting_location": {
    "host": {
      "host_employee_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
    }
  }
}

Response

Success

idstring required

Canonical task ID (tsk_ followed by 32 lowercase hexadecimal UUID characters).

status'NEEDS_AVAILABILITY' | 'WAITING_FOR_CANDIDATE' | 'READY_TO_SCHEDULE' | 'READY_TO_RESCHEDULE' | 'HOLD' | 'READY_TO_SEND_TO_CANDIDATE' | 'SCHEDULED' | 'COMPLETED' | 'CANCELED' | 'NEEDS_DEBRIEF' required
is_urgentboolean required
queue_idstring nullable required

Canonical task queue ID (que_ followed by 32 lowercase hexadecimal UUID characters).

tagsstring[] required
is_debrief_requiredboolean required
created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

app_urlstring uri required

Example response

{
  "id": "tsk_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "application": {
    "id": "app_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "candidate": {
      "id": "can_a1b2c3d4e5f64789a1b2c3d4e5f64789"
    },
    "job": {
      "id": "job_a1b2c3d4e5f64789a1b2c3d4e5f64789"
    }
  },
  "job_stage": {
    "id": "stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "assignee": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "queue_id": "que_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "notes": [
    {
      "author": {
        "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
      }
    }
  ]
}