jobs

Update a job

Update a job per JSON Merge Patch specification (RFC 6902). The endpoint ignores all absent job properties.

  • updating of a field might trigger job approval
  • modification date is changed
  • all validations rules are applied for required fields and dependencies

Usage Examples

Upsert Free Text Property

[
  {
    "op":"add",
    "path":"/properties/-",
    "value":{
      "id":"5ec29396d4a5de40e44b1f5a",
      "value":{
        "label":"Some text"
      }
    }
  }
]

Upsert Drop-down Property

[
  {
    "op":"add",
    "path":"/properties/-",
    "value":{
      "id":"5ec29396d4a5de40e44b1f5a",
      "value":{
        "id":"XXX"
      }
    }
  }
]

Upsert Drop-down Property via externalCode

[
  {
    "op":"add",
    "path":"/properties/-",
    "value":{
      "id":"5ec29396d4a5de40e44b1f5a",
      "value":{
        "externalCode":"FULL_TIME"
      }
    }
  }
]

Remove a Property

[
  {
    "op":"add",
    "path":"/properties/-",
    "value":{
      "id":"5ec29396d4a5de40e44b1f5a",
      "value":{}
    }
  }
]

Upsert Compensation

Create/update job compensation field. Sets min, currency and period values but leaves max null.

[
  {
    "op":"add",
    "path":"/compensation",
    "value":{
      "min":25,
      "max":null,
      "currency":"PLN",
      "period":"HOURLY"
    }
  }
]

Upsert Compensation Properties

Update job compensation.min and compensation.currency fields but leave current compensation.max and compensation.period intact.

Note: The compensation field must not be null. Use the previous approach if that's the case

[
  {
    "op": "add",
    "path": "/compensation/min",
    "value": 425
  },
  {
    "op": "add",
    "path": "/compensation/currency",
    "value": "USD"
  }
]

Delete Compensation Properties

Delete the currency.min field but leave compensation.max, compensation.currency and compensation.period intact.

[
  {
    "op": "remove",
    "path": "/compensation/min"
  }
]
patch/jobs/{jobId}

Request

  • Base URL
    https://api.smartrecruiters.com
  • URL
    https://api.smartrecruiters.com/jobs/{jobId}
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: jobs_manage

Request body

pathstring required

Example request

[
  {
    "path": "/path",
    "op": "add",
    "value": "example"
  },
  {
    "path": "/path",
    "op": "move",
    "from": "/origin"
  },
  {
    "path": "/path",
    "op": "remove"
  }
]

Response

Updated job

idstring
titlestring
refNumberstring
createdOnstring date-time
updatedOnstring date-time

Job modification date

lastActivityOnstring date-time

Indicates last activity associated with a job

status'CREATED' | 'SOURCING' | 'FILLED' | 'INTERVIEW' | 'OFFER' | 'CANCELLED' | 'ON_HOLD' | 'OTHER'
postingStatus'PUBLIC' | 'INTERNAL' | 'NOT_PUBLISHED' | 'PRIVATE'
targetHiringDatestring date-time
hiringProcessIdstring

ID of hiring process associated with this job

templateboolean

Changes

No recorded changes to this operation across all 1 revision of this API.