API reference/Opportunity pipeline/Interviews

PATCHLive

Update interview

Reschedules an interview, changes its kind/location/participants, or records its outcome.

/v1/interviews/{interviewId}

Authorization

Credential

oauth_user

Required scopes

applications:write

Path parameters

interviewId

string · required

Request body

JSON · application/json

kindstring

phone · video · technical · onsite · panel

scheduledAtnumber

locationstring

statusstring

completed · no_show

outcomestring

interviewerContactIdsarray

Implementation note

Outcome recording happens here: set `status` to completed or no_show (optionally with an `outcome` summary). Canceling is a separate state transition — use `interview-cancel`. Patching a canceled interview is a conflict. `interviewerContactIds` replaces the participant list.

Error responses

400Invalid request

The request body was missing, malformed, or failed schema validation. Field-level problems are listed under `issues`.

401Authentication required

No valid credentials were supplied. Attach a Bearer access token and retry.

402Upgrade required

The authenticated user's plan does not include this capability. `feature` names the gated capability, `requiredPlan` the cheapest plan that unlocks it, `currentPlan` the user's plan today, and `upgradeUrl` links to checkout. This is a plan gate, not a transient error — retrying without upgrading fails again; surface `upgradeUrl` to the user instead. Dormant until a plan that grants the feature is active, so a route that documents it may not currently return it.

403Insufficient scope

The token is valid but lacks the OAuth scope (or token kind) this endpoint requires.

404Resource not found

The addressed resource does not exist, or is not visible to the caller.

409Conflicting state

The resource is in a state that does not allow this operation (e.g. a terminal application stage or an already-decided offer).