Skip to main content
PATCH
Update an application's pipeline status

Authorizations

Authorization
string
header
required

API key authentication for the public API. Pass your API key as a Bearer token.

Headers

If-Match
string

The application's ETag from a prior GET response. When supplied, the update is rejected with 409 if the application changed since (optimistic concurrency).

Path Parameters

application_id
string<uuid>
required

Body

application/json

Request body for PATCH /applications/{id}. Only status is writable.

status
enum<string>
  • applied - Applied
  • screened - Screened
  • interviewed - Interviewed
  • shortlisted - Shortlisted
  • hired - Hired
  • rejected - Rejected
Available options:
applied,
screened,
interviewed,
shortlisted,
hired,
rejected

Response

Full application: adds custom_fields to the list shape.

The interview / insights / CV-evaluation sub-resources are reached via the links block (each is its own typed endpoint), not inlined here.

id
string<uuid>
required
read-only
external_id
string | null
required
read-only

The application's ID in the system that supplied it, in that system's own form. Unique per job posting and source.

status
enum<string>
required
  • applied - Applied
  • screened - Screened
  • interviewed - Interviewed
  • shortlisted - Shortlisted
  • hired - Hired
  • rejected - Rejected
Available options:
applied,
screened,
interviewed,
shortlisted,
hired,
rejected
created_at
string<date-time>
required
read-only
candidate
object
required
job
object
required
interview
object | null
required

Lean interview pointer on an application (full result is its own sub-resource).

custom_fields
unknown
required