Preview prospect conversion to an application
Preview prospect conversion to an application
Required scopes: prospects:read, prospects:write, applications:write
Previews conversion without writing. An unavailable Prospect returns 404 prospect_not_found with param: prospect_id; an unavailable target Job Posting returns 404 job_posting_not_found with param: job_posting_id. Use a fresh Idempotency-Key after resolving blockers.
Example (curl):
curl -X POST https://api.yardstick.team/v1/prospects/pro_abc123/actions/convert_to_application/preview \
-H 'Authorization: Bearer ys_sk_live_…' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: 7c3a…' \
-d '{"job_posting_id":"jp_xyz789"}'
Example (TypeScript):
await fetch("https://api.yardstick.team/v1/prospects/pro_abc123/actions/convert_to_application/preview", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.YS_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({ job_posting_id: "jp_xyz789" }),
});
Request
- Base URL: https://api.yardstick.team
- URL: https://api.yardstick.team/v1/prospects/{prospect_id}/actions/convert_to_application/preview
- Auth: HTTP bearer
Headers
Required for this operation. Reuse the same key to safely retry the same request.
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.