Public API v1
Public API v1

Cancel an interview nobody has started

Close an interview the candidate has not started — they closed the tab, the microphone failed, they changed their mind. The credit set aside for it is released at once; nothing is charged; the record is kept (this is not deletion). Returns 409 ALREADY_STARTED once the candidate has pressed Start, and 409 ALREADY_FINISHED for a completed or failed interview. Cancelling twice is harmless.

Interviews created through this API also close on their own one hour after they were meant to start (join_expires_at on the detail).

post/api/public/v1/interviews/{interview_id}/cancel

Request

  • Base URL: https://api.thebetterhire.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.thebetterhire.ai/api/public/v1/interviews/{interview_id}/cancel
  • Auth: HTTP bearer

Path parameters

interview_idstring required

Response

Successful Response

idstring required
statusstring required

'cancelled'.

messagestring required

Changes

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