Apply a candidate status-change email decision
Apply a candidate status-change email decision
Required scopes: applications:write, applications:transition_status, communications:write
Secret keys only. Applies the Application status transition and records the candidate email decision intent. Use Idempotency-Key for retries; replaying the same key with the same decision returns the prior result. send_now additionally requires communications:send and is rejected for approval-required communications.
Example (curl):
curl -X POST https://api.yardstick.team/v1/applications/app_abc123/email-decision/apply \
-H 'Authorization: Bearer ys_sk_live_…' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: 7c3a…' \
-d '{"status":"Interviewing","decision":"review_edit"}'
Example (TypeScript):
await fetch("https://api.yardstick.team/v1/applications/app_abc123/email-decision/apply", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.YS_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({ status: "Interviewing", decision: "review_edit" }),
}).then((r) => r.json());
Request
- Base URL: https://api.yardstick.team
- URL: https://api.yardstick.team/v1/applications/{application_id}/email-decision/apply
- Auth: HTTP bearer
Headers
Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.
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
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.