Update a candidate

Updates a whitelisted subset of mutable fields. Most candidate state
is driven by the pipeline engine and is not externally mutable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Candidate UUID.

Body Params

At least one mutable field is required. status is read-only —
it is driven by the pipeline engine. To move a candidate to a
specific node, use POST /candidates/:id/rewind or
POST /candidates/:id/fast-forward.

boolean
string
length ≤ 256
Headers
string
^[A-Za-z0-9_-]{8,64}$

Optional. Send the same key on a retry to make the request
idempotent. The first successful 2xx response is cached for
24 hours; subsequent retries with the same key return the
cached response with Idempotent-Replay: true. Reusing a key
with a different request body returns 409
idempotency_conflict. Format: 8–64 chars of [A-Za-z0-9_-]
— a UUID v4 is a fine default.

Responses

Language
Credentials
Bearer
hk_live_<secret>
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json