Skip to main content
POST
/
interview
/
invite
Invite candidates to an interview
curl --request POST \
  --url https://public.api.micro1.ai/interview/invite \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "interview_id": "123e4567-e89b-12d3-a456-426614174000",
  "candidates": [
    {
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "job_application_id": "123e4567-e89b-12d3-a456-426614174000",
  "candidate_id": "123e4567-e89b-12d3-a456-426614174000",
  "disable_email_notification": false
}
'
{
  "status": true,
  "message": "Invitations sent successfully",
  "data": {
    "invitations": [
      {
        "candidate_id": "123e4567-e89b-12d3-a456-426614174000",
        "candidate_email": "[email protected]",
        "invite_url": "https://interview.micro1.ai/intro/micro1?cid=123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

API key to access the API

Body

application/json

Request body to create an interview

​
interview_id
string
required

The ID of the interview to invite candidates to

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
candidates
object[]

The list of candidates to invite

Example:
[
  {
    "name": "John Doe",
    "email": "[email protected]"
  }
]
​
job_application_id
string

The ID of the job application to invite candidates (Optional)

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
candidate_id
string

The ID of the candidate to re-send the invitation (Optional)

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
disable_email_notification
boolean
default:false

Whether to disable the email notification sent to the candidate for the interview invitation

Example:

false

Response

Successful response

​
status
boolean

The status of the invitation

Example:

true

​
message
string

The message of the invitation

Example:

"Invitations sent successfully"

​
data
object

The data of the invitation