v1

latestOpenAPI 3.1.02026-07-224239180.9 KB

Job

Update a job

Updates the supplied fallback name or internal note for a job. Omitted fields are preserved, and both fields are write-only because the current job summary RPC does not return them. An empty PATCH body is rejected.

patch/v1/jobs/{jobId}

Path parameters

jobIdstring required

a job 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:job_a1b2c3d4e5f64789a1b2c3d4e5f64789

Request body

fallback_namestring nullable

Candidate-facing fallback job name, shown when no job posting name is linked to the candidate's application (candidate portal, sourcing links, and job-name tokens). Set to null to fall back to the internal job name.

internal_notestring nullable

Free-form internal note about the job; never shown to candidates.

Response

Success

idstring required

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

namestring required

status'DRAFT' | 'OPEN' | 'CLOSED' required

confidentialboolean required

locationsstring[] required

created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

Example response

{
  "id": "job_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "hiring_team": [
    {
      "employee": {
        "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
      }
    }
  ]
}