Generate a scheduling link for an interview session
Generate a scheduling link for an interview session
Required scopes: scheduling:write
Mints a fresh scheduling link bound to the session's assigned interviewer. Returns 200 with { scheduling_link, provider, expires_at, link_id } on success, or 409 with { blocker_code, blocker_message, blocker_metadata } when blocked. provider is "calcom" or "calendly". Regeneration: each call generates a fresh scheduling link. Previous links remain valid until their TTL expires; use the returned link_id to revoke a prior link out-of-band if needed. Idempotency: supply Idempotency-Key to dedupe retries; replayed requests return the cached response without minting a second link. Inherits the default per-token rate limit applied by withApi.
Example (curl):
curl -X POST https://api.yardstick.team/v1/interview_sessions/is_abc123/actions/generate_link \
-H 'Authorization: Bearer ys_sk_live_…' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: 7c3a…' \
-d '{}'
Example (TypeScript):
await fetch(
"https://api.yardstick.team/v1/interview_sessions/is_abc123/actions/generate_link",
{
method: "POST",
headers: {
Authorization: `Bearer ${process.env.YS_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": crypto.randomUUID(),
},
body: JSON.stringify({}),
},
).then((r) => r.json());
Request
- Base URL: https://api.yardstick.team
- URL: https://api.yardstick.team/v1/interview_sessions/{interview_session_id}/actions/generate_link
- Auth: HTTP bearer
Path parameters
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.
Response
Link minted. Each call generates a fresh scheduling link; previous links remain valid until their TTL expires.
Changes
No recorded changes to this operation across all 1 revision of this API.