interviews

Launch a campaign: validate, mark active, and send or schedule invitations.

Invitations go out on the campaign's channel: in_app_chat emails each contact a personal interview link, slack sends a Slack DM (email fallback), teams sends a Microsoft Teams chat message (email fallback). Participants self-schedule. Campaigns still on a legacy channel (google_meet, phone, imessage, whatsapp) are rejected with 400; switch the channel first.

Campaigns with start_immediately=false and a future timeframe_start do NOT send invitations at launch — a job sends them when the campaign opens (date-only starts resolve to 08:00 in the campaign's timezone). timeframe_end is a soft response deadline shown to participants; it never blocks late responses.

Validation (goal length, at least one contact, at least one question, Slack connection + reachable contacts for Slack campaigns) runs first; on failure the campaign stays in draft.

post/v1/interviews/{interview_id}/start

Request

Path parameters

interview_idstring uuid required

Headers

X-API-Keystring nullable

Response

Successful Response

scheduled_countinteger required
messagestring required

Changes

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status