POST
/
v1
/
invite
Invite a new or existing candidate to one or more assessments
curl --request POST \
  --url https://api.hiringbranch.com/connect/v1/invite \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'instance: <instance>' \
  --data '{
  "email": "candidate@enterprise.com",
  "firstName": "John",
  "lastName": "Doe",
  "assessments": [
    "59bc377497c7ac0cbc1b69c7",
    "59bc377497c7ac0cbc1b69c8",
    "59bc377497c7ac0cbc1b69c9"
  ]
}'
[
  {
    "link": "https://portal.hiringbranch.com/abc/#?sessionToken=123456789123456789",
    "invitationStatus": "SENT",
    "candidateId": "59bc377497c7ac0cbc1b69c8"
  }
]

Authorizations

​
X-API-Key
string
header
required

Api key given by Hiringbranch

Headers

​
instance
string
required

Name of the instance

Query Parameters

​
sendInvite
boolean
default:false

Determines if the invite should be sent by us

Body

Information about the candidate and the assessments for the invite

The body is of type object.

Response

200
application/json

List of links and invitation status

The response is of type object[].