Preview a candidate status-change email decision
Preview a candidate status-change email decision
Required scopes: applications:read, communications:read
Secret keys only. Previews the dashboard-visible candidate email decision states for a status transition without mutating the Application or drafts. Returns decision vocabulary, sender override validation, personalization tier, safety state, and side-effect preview.
Example (curl):
curl -X POST https://api.yardstick.team/v1/applications/app_abc123/email-decision/preview \
-H 'Authorization: Bearer ys_sk_live_…' \
-H 'Content-Type: application/json' \
-d '{"status":"Interviewing"}'
Example (TypeScript):
await fetch("https://api.yardstick.team/v1/applications/app_abc123/email-decision/preview", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.YS_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ status: "Interviewing" }),
}).then((r) => r.json());
Request
- Base URL: https://api.yardstick.team
- URL: https://api.yardstick.team/v1/applications/{application_id}/email-decision/preview
- 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.