Interviews

Void Interview Endpoint

Mark an interview as invalid so it stops counting in role benchmarks, candidate counts, and pipeline aggregations. The interview record (transcript, recording, analysis if any) is preserved — voiding is a data-hygiene action, not a delete.

Refunds are explicitly out of scope. Voiding does not touch the wallet ledger; charge disputes are a separate manual flow. This decoupling is intentional anti-abuse design.

Requires admin or recruiter role.

post/api/interviews/{interview_id}/void

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/interviews/{interview_id}/void
  • Auth: HTTP bearer

Path parameters

interview_idstring uuid required

Request body

reasonstring required
notesstring nullable

Response

Successful Response

successboolean required
interview_idstring required
excludedboolean required
excluded_reasonstring nullable
excluded_notesstring nullable
excluded_atstring nullable
excluded_bystring nullable
messagestring nullable

Changes

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