How-to: Deleting an Interview

​

When to use this

Use deleteInterview when an interview should no longer exist in Hireflix. The most common reason is re-inviting a candidate: each email can only be invited once per position, so you have to delete the old interview first.

If you only want to reject a candidate and keep their answers, discard the interview instead.

You can’t restore a deleted interview through the API. Double-check the interview ID before you send the request.

​

GraphQL Request

Replace <interview-id> with the ID of the interview you want to delete. You can find it by listing the interviews for a position. Don’t forget to add your Hireflix API Key in the headers, and send the request to https://api.hireflix.com/me.

​

Explanation

• input.interviewId: the interview you want to delete.
• deleteInterview (union): returns one of four possible types. Check __typename to determine which one you got:

__typename	Meaning
InterviewDeletePayload	The interview was deleted. deletedInterviewId contains its ID.
InterviewNotFoundError	The interview doesn’t exist or was already deleted.
PositionNotFoundError	The position this interview belongs to couldn’t be found.
ForbiddenError	Your API key doesn’t have access to this interview or its position.

GraphQL responses return HTTP 200 even when an operation fails. Treat anything other than InterviewDeletePayload, as well as a top-level errors array, as a failed delete.

​

Example Response

{
  "data": {
    "deleteInterview": {
      "__typename": "InterviewDeletePayload",
      "deletedInterviewId": "<interview-id>"
    }
  }
}

If the deletion fails, for example because the interview doesn’t exist, you’ll get an error type instead:

{
  "data": {
    "deleteInterview": {
      "__typename": "InterviewNotFoundError",
      "code": 404,
      "message": "Interview not found: <interview-id>"
    }
  }
}

​

What happens after deleting

• Queries: the interview is no longer returned. For example, interview(id) returns null.
• Webhooks: Hireflix sends an interview.delete event to any webhook subscribed to INTERVIEW_DELETE.
• Re-inviting: you can invite the same email to the same position again.

​

Good to know

• No need to discard first: the dashboard asks you to discard an interview before deleting it, but this mutation works in any stage.
• No active subscription needed: you can still delete interviews if your subscription has expired.

Learn next?

Let’s learn how to bulk download interview videos for a position.