v1

latestOpenAPI 3.1.02026-07-224239180.9 KB

Job Stage

Update a job stage

Updates a job stage's settings. Targets the stage settings only; the base stage (name, index, ATS identity, schedulable) is ATS-sync-owned and read-only. Every supplied settings group merges per field, including self_schedule_defaults and availability_request_defaults; omitted fields are preserved. At least one group is required. Set automation.create_automated_task_on_behalf_of to null to clear it. The Java handler does not support clearing automation.default_task; omit it to preserve the current value. Requires a WRITE-scoped token with the beta:jobs:write entitlement.

patch/v1/job-stages/{jobStageId}

Path parameters

jobStageIdstring required

a job stage 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:stg_a1b2c3d4e5f64789a1b2c3d4e5f64789

Request body

Example request

{
  "settings": {
    "automation": {
      "create_automated_task_on_behalf_of": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
    }
  }
}

Response

Success

idstring required

Canonical job stage ID (stg_ followed by 32 lowercase hexadecimal UUID characters).

job_idstring required

Canonical job ID (job_ followed by 32 lowercase hexadecimal UUID characters).

namestring required

indexinteger required

schedulableboolean required

has_custom_interview_planboolean required

created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

Example response

{
  "id": "stg_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "job_id": "job_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "settings": {
    "automation": {
      "create_automated_task_on_behalf_of": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
    }
  }
}