Skip to main content
POST
/
interviews
cURL
curl --request POST \
  --url https://api.alpharun.com/api/v1/interviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "job_opening_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone_number": "<string>",
    "custom_fields": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "interview_custom_fields": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  }
]
'
{
  "successful_imports_count": 123,
  "failed_imports_count": 123,
  "failed_contacts": [
    {
      "job_opening_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[email protected]",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone_number": "<string>",
      "resume": {
        "content": "<string>",
        "mimetype": "<string>"
      },
      "custom_fields": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "interview_custom_fields": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Array of candidates to add to the job opening

Minimum array length: 1
​
job_opening_id
string<uuid>
required

ID of the job opening to add contacts to

​
email
string<email>
required

Email address of the contact

​
first_name
string

First name of the contact

​
last_name
string

Last name of the contact

​
phone_number

Phone number of the contact

​
resume
object

Resume of the contact.

​
custom_fields
object[]

Custom fields to populate on the contact

​
interview_custom_fields
object[]

Custom fields to populate on the interview

Response

Candidates import results

​
successful_imports_count
integer
​
failed_imports_count
integer
​
failed_contacts
object[]
Minimum array length: 1