Skip to main content
POST
Schedule session

Authorizations

x-api-key
string
header
required

API key with the iv_live_ prefix. Create one under Developer → API Keys.

Body

application/json
candidate_id
string<uuid>
required

Participant to schedule

role_id
string<uuid>
required

Role to use

stage
string
required

Stage label, e.g. "screen", "technical", "final"

interview_id
string<uuid>

Specific round ID — auto-selected if omitted

idempotency_key
string

Unique key per request — returns the existing session if the key was already used

Maximum string length: 255
scheduled_at
string<date-time>

When to schedule the session

timezone
string

IANA timezone, e.g. America/New_York (default: UTC)

notes
string

Internal notes — not shown to the candidate

Maximum string length: 1000
force
boolean

Skip the duplicate-session check (default: false)

accountSlug
string

Team slug — required for session (cookie) auth

Response

Success

Last modified on July 20, 2026