Rewind a candidate to an earlier node

Move the candidate backward in the pipeline to a target node.
Deletes the candidate's responses for the target node and every
descendant of it (their work past that point is wiped).

Direction rules

  • target_node_id must be an ancestor of the candidate's current
    node. Trying to rewind to the current node or a node ahead of it
    returns 422.
  • To move forward, use POST /candidates/:id/fast-forward.

Side effects

  • Credits are deducted for the target node's type (the candidate
    will replay that step).
  • The candidate receives a "your application has progressed" email
    unless notify_candidate: false is sent.
  • Pipeline-automation nodes between target and current are not
    re-executed; only current_node_id is updated.

Dry run

Send dry_run: true to preview which responses would be deleted
without applying any change.

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

Candidate UUID.

Body Params
uuid
required

UUID of the target node. Must match an entry in
pipeline.nodes[].id for the candidate's pipeline.

boolean
Defaults to false

If true, return the would-be result without applying any
change — no DB writes, no credit deduction, no email sent.
applied in the response will be false.

boolean
Defaults to true

If true (default), the candidate receives a "your application
has progressed" email after the move. Set to false to perform
silent moves (e.g., bulk operations or backfills).

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