Docs
API reference

Update a job

PATCH
/api/v1/jobs/{id}

Changes the fields you send; null clears an optional field. Send the job's revision as If-Match to refuse the change if someone updated the job since you read it (revision_mismatch).

Required scope: jobs:write.

Errors

  • 400: invalid_content_type, invalid_json, request_body_too_large, unknown_field
  • 401: authentication_required, invalid_api_key
  • 403: api_access_disabled, insufficient_scope
  • 404: job_not_found
  • 409: job_exists
  • 412: revision_mismatch
  • 422: invalid_parameter
  • 429: rate_limit_exceeded
  • 500: api_error
  • 503: maintenance_mode, service_unavailable

Authorization

ApiKey
headerAuthorizationBearer <probb_live_<id>_<secret>>

Path Parameters

id*string

The job's ID.

Length1 <= length <= 200

Request Body

application/json
  1. body
title?string

The job title.

Length1 <= length <= 160
description?string

The full job description, 10 to 20,000 characters.

Length10 <= length <= 20000
company?|null
team?|null
location?|null
level?|null
employmentType?|null
externalId?|null

Response Body

Success.

application/json
  1. response
object*string
id*string

The job's ID. The same ID the app uses.

externalId*|

Your own ID for the job, unique within the organization.

title*|

The job title.

description*string

The full job description text.

company*|

The hiring company.

team*|

The hiring team or department.

location*|

Where the job is based.

level*|

The seniority level, for example Senior.

employmentType*|

How the person is employed.

status*string

closed jobs accept no new reports or interviews.

Value in"open""closed"
closedAt*|

When the job was closed.

closeReason*|

Why the job was closed, when it was closed with a reason.

revision*string

Changes on every update. Send it as If-Match to avoid overwriting newer changes.

createdAt*string

When the job was created.

Formatdate-time
updatedAt*string

When the job last changed.

Formatdate-time
Example Request
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X PATCH "$PROBB_URL/api/v1/jobs/ID_VALUE" \  -H "Authorization: Bearer $PROBB_API_KEY" \  -H 'Content-Type: application/json' \  --data-binary '{  "title": "Senior Backend Engineer",  "location": "London"}'
Example Response
{  "object": "job",  "id": "string",  "externalId": "string",  "title": "string",  "description": "string",  "company": "string",  "team": "string",  "location": "string",  "level": "string",  "employmentType": "full_time",  "status": "open",  "closedAt": "2019-08-24T14:15:22Z",  "closeReason": "filled",  "revision": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}