v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB

Jobs

Update Job

patch/unified/ats/jobs/{id}

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

unified_custom_fieldsobject nullable

Custom Unified Fields configured in your StackOne project

codestring nullable

Code of the job

titlestring nullable

Title of the job

descriptionstring nullable

Description of the job

statusstring nullable

Status of the job

department_idsstring[] nullable

Department ids of the job

location_idsstring[] nullable

Location ids of the job

confidential'true' | 'false' | 'unmapped_value' | 'null' nullable

Confidential status of the job

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "unified_custom_fields": {
    "my_project_custom_field_1": "REF-1236",
    "my_project_custom_field_2": "some other value"
  },
  "code": "184919",
  "title": "Software Engineer",
  "description": "Responsible for identifying business requirements",
  "status": "archived",
  "job_status": {
    "value": "published"
  },
  "department_ids": [
    "308570",
    "308571",
    "308572"
  ],
  "location_ids": [
    "668570",
    "678571",
    "688572"
  ],
  "hiring_team": [
    {
      "user_id": "123456",
      "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@gmail.com",
      "role": "Software Engineer"
    }
  ],
  "interview_stages": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "unified_custom_fields": {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value"
      },
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-01T01:01:01.000Z"
    }
  ],
  "custom_fields": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Training Completion Status",
      "value_id": "value_456",
      "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ],
  "passthrough": {
    "other_known_names": "John Doe"
  }
}

Response

The job was successfully updated.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}