Applications

Update application stage

Update application stage

Required scopes: applications:write

Example (curl):

curl -X PATCH https://api.yardstick.team/v1/applications/app_def456 \
  -H 'Authorization: Bearer ys_sk_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"stage":"Phone Screen"}'

Example (TypeScript):

await fetch("https://api.yardstick.team/v1/applications/app_def456", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.YS_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ stage: "Phone Screen" }),
});
patch/v1/applications/{application_id}

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/applications/{application_id}
  • Auth: HTTP bearer

Path parameters

application_idstring required

Headers

Idempotency-Keystring

Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Request body

stagestring

Response

Success

is_candidateboolean required

Explicitly admitted to the interview process; Review Applications and Candidates are mutually exclusive per application.

candidate_admission_idstring uuid nullable required

Raw current admission UUID, required as expected_admission_id when undoing.

candidate_admitted_atstring nullable required
candidate_admission_originstring nullable required
candidate_activity_started_atstring nullable required

Non-null after durable candidate activity; undo is then unavailable.

idstring required

Display id, e.g. app_<base32>

object'application' required
person_idstring required

Canonical per_... person id.

statusstring required
stagestring required

Deprecated free-form stage label. Status transitions never change it; read pipeline_stage_id for the pipeline position.

pipeline_stage_idstring nullable required

Display id (pst_<base32>) of the configured pipeline stage (board column) the application sits in; every status transition moves it to the stage mapped to the new status. Null when no configured stage is assigned.

job_idstring nullable required

Canonical job_... Job id when the application is linked to a Job; null for legacy or unlinked applications.

job_posting_idstring nullable required
livemodeboolean required
createdstring nullable required
updatedstring nullable required
archived_atstring nullable required

ISO-8601 UTC; non-null when the application has been archived.

archived_reasonstring nullable required

Free-text archive reason captured at archive time; nullable.

Changes

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