Applications

Transition application status

Transition application status

Required scopes: applications:write, applications:transition_status

Non-terminal transitions may write immediately. Sensitive terminal or provider-dependent transitions return approval-required or blocked envelopes; this route does not send communications, create scheduling links, update scorecards, publish jobs, archive records, or create reports. Target the move by status (resolved to the configured stage internally) or, additively, by pipeline_stage_id (move to a configured stage by id; status if also sent must equal the stage's mapped status). The same denied-state semantics apply either way: an unmet per-stage action gate returns HTTP 409 action_gate_blocked, and an approval-required target returns the HTTP 202 approval-preview envelope. A mutating response reports the resolved pipeline_stage_id.

Example (curl):

curl -X POST https://api.yardstick.team/v1/applications/app_def456/actions/transition_status \
  -H 'Authorization: Bearer ys_sk_live_…' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 7c3a…' \
  -d '{"status":"Screening","reason":"Meets baseline requirements"}'

Example (TypeScript):

await fetch(
  "https://api.yardstick.team/v1/applications/app_def456/actions/transition_status",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.YS_API_KEY}`,
      "Content-Type": "application/json",
      "Idempotency-Key": crypto.randomUUID(),
    },
    body: JSON.stringify({
      status: "Screening",
      reason: "Meets baseline requirements",
    }),
  },
);
post/v1/applications/{application_id}/actions/transition_status

Request

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

Path parameters

application_idstring required

Headers

Idempotency-Keystring required

Required for this operation. Reuse the same key to safely retry the same request.

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

statusstring
reasonstring
employment_start_datestring
pipeline_stage_idstring

Response

Success

OR

Changes

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