Invite Candidate To Interview

Invites a candidate to an interview in Hireflix.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

stringrequired

The Hireflix position ID.

stringrequired

The candidate's first name.

string

The candidate's last name.

stringrequired

The candidate's email address.

string

The candidate's phone number.

string

An external ID to associate with the interview.

boolean

Whether to suppress Hireflix notifications for this invite.

Uncommon arguments

object

Optional JSON metadata to store with the interview invite.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v1/universal/hireflix/latest/actions/invite-candidate-to-interview" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "variables.input.positionId": "",
  "variables.input.candidate.firstName": "",
  "variables.input.candidate.email": ""
}'

{
  "success": true,
  "data": [
    {
      "__typename": "string",
      "candidate": {
        "email": "[email protected]",
        "firstName": "Ava",
        "lastName": "Chen",
        "phone": "string"
      },
      "code": "string",
      "expires": 1,
      "externalId": "string",
      "fieldErrors": {},
      "id": "string",
      "message": "string",
      "name": "Ava Chen",
      "position": {
        "id": "string",
        "name": "Ava Chen"
      },
      "status": "string"
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.