Scheduling

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());
post/v1/interview_sessions/{interview_session_id}/actions/generate_link

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

interview_session_idstring required

Headers

Idempotency-Keystring

Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.

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.

Response

Link minted. Each call generates a fresh scheduling link; previous links remain valid until their TTL expires.

scheduling_linkstring required

Provider-rendered scheduling URL. Treat as opaque; do not parse.

provider'calcom' | 'calendly' required

Underlying provider that minted the link.

expires_atstring required

ISO-8601 UTC timestamp at which the corresponding scheduling_link_tokens row expires (30-day TTL).

link_idstring required

Display id of the scheduling_link_tokens row backing this link. Use for out-of-band revocation lookups.

Changes

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