Skip to main content

When to use this

Use these mutations to update the status of an interview through the Hireflix API. For example, mark a candidate as discarded or shortlisted (finalist) after review. This how-to guide shows both mutations. This allows your system to stay in sync with Hireflix when recruiters move candidates between stages in your ATS or workflow.

GraphQL Request: Discard an Interview

Use this mutation to move a candidate to the discarded stage. This sets archive: true and returns the time when the interview was discarded. Don’t forget to update the Hireflix API Key in the headers.

Explanation

  • Interview(id) — the ID of the interview you want to update.
  • archive(archive: true) — marks the interview as discarded.
  • discardedAt — timestamp indicating when the interview was archived.

Example Response

{
  "data": {
    "Interview": {
      "archive": {
        "id": "68b4404fc39e5db535d2e005",
        "discardedAt": 1760364046835
      }
    }
  }
}

GraphQL Request: Shortlist an Interview

Use this mutation to move a candidate to the shortlisted (finalist) stage. Don’t forget to update the Hireflix API Key in the headers.

Explanation

  • Interview(id) — the ID of the interview you want to update.
  • finalist(true) — marks the interview as shortlisted.
    • To undo this and move the candidate back to the “to evaluate” stage, set finalist(false).

Example Response

{
  "data": {
    "Interview": {
      "finalist": {
        "id": "68d4164f19367e041b2030c0"
      }
    }
  }
}

Learn next?

Let’s learn how to fetch positions.