Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Job

job.update

Updates an existing job. At least one field other than jobId must be supplied.

Requires the jobsWrite permission.

post/job.update

Request body

jobIdstring uuid required

The unique id of the job to update

titlestring

A new title for the job

teamIdstring uuid nullable

The new team to associate with the job. Pass null (together with another field to update) to remove the existing team.

locationIdstring uuid

The new location to associate with the job

defaultInterviewPlanIdstring uuid

The new default interview plan to associate with the job

customRequisitionIdstring nullable

The new custom requisition id for the job. Pass null (together with another field to update) to clear the existing value.

Example request

{
  "jobId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "title": "Software Engineer",
  "teamId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "locationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "defaultInterviewPlanId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "customRequisitionId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the job.update endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "1be42b8e-cafd-4beb-8121-f4981eb20f42",
    "title": "Software Engineer",
    "confidential": false,
    "status": "Open",
    "employmentType": "FullTime",
    "locationId": "3ae2b801-19f6-41ef-ad28-214bd731948f",
    "departmentId": "f9e52a51-a075-4116-a7b8-484deba69004",
    "defaultInterviewPlanId": "595ae947-e308-4a36-af06-70b7f6e0fb82",
    "interviewPlanIds": [
      "595ae947-e308-4a36-af06-70b7f6e0fb82"
    ],
    "jobPostingIds": [],
    "customRequisitionId": "ENG-01",
    "brandId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "hiringTeam": [],
    "customFields": [],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "openedAt": "2024-01-02T00:00:00.000Z",
    "closedAt": null
  }
}