/applicants/{applicant_id}/interviews

put

https://partners.apploi.com/applicants/{applicant_id}/interviews

Endpoint for scheduling or cancelling interviews for candidates. This endpoint allows the creation of interview appointments for a specific applicant and job. If the API is called again for the same candidate and job combination, the existing interview details will be updated with the newly provided information, effectively acting as an update operation. It cancels the latest created upcoming interview when the cancel flag is set to true. When cancelling, all other fields in the request body are ignored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicant_id

string

required

The application form ID corresponding to a job application in the Apploi platform. The application form ID is a unique identifier for the job application in the Apploi platform. The application form ID can be found in the 'id' field of the each of the items in the response body of a call to the /applicants endpoint in the Apploi Partner API.

Examples: 265733753, 265733754, etc.

Body Params

Pass in a JSON body with interview details. Either interviewerId must be provided, or both interviewerTeamId and interviewerEmail must be provided.

Option 1: Using interviewerId

{
    "date": "2022-12-05T17:30:00Z",
    "duration": "60",
    "timezone": "America/New_York",
    "location": "Virtual",
    "interviewerId": "123456"
}

Option 2: Using interviewerTeamId and interviewerEmail

{
    "date": "2022-12-05T17:30:00Z",
    "duration": "60",
    "timezone": "America/New_York",
    "location": "Virtual",
    "interviewerEmail": "[email protected]",
    "interviewerTeamId": "23567"
}

Option 3: Cancelling the latest interview

Note: Scheduling fields are still required by the schema but will be ignored by the service when cancel is true.

{
    "date": "2022-12-05T17:30:00Z",
    "duration": "60",
    "timezone": "America/New_York",
    "interviewerId": "123456",
    "cancel": true
}

The JSON document schema for scheduling an interview for a specific candidate for a specific instance of a job application.

cancel

boolean

When set to true, cancels the latest created upcoming interview for the specified applicant. All other fields in the request body are ignored when this flag is true.

Defaults to false.

date

date-time

required

Interview date and time, specified in ISO 8601 format. Non-ISO 8601 format date-time strings are not allowed. The timezone information provided in this value will be overridden by the value provided in the timezone field. However, this field still requires timezone information to be present, so simply appending Z at the end of the date-time string is sufficient.

Examples: "2021-03-25T10:00:00Z", "2024-10-22T14:00:00Z", etc.

duration

string

required

Defaults to 60

The interview duration in minutes. The type of this field is a numeric integer string. Non-numeric string characters are not allowed.

Examples: "30", "60", "90", etc.

interviewerEmail

string

Defaults to [email protected]

The email address of the interviewer in the Apploi platform. This field is only required when the interviewerId is not available. This must be a valid email address string of a team member recorded in the Apploi platform.

Examples: "[email protected]", "[email protected]", etc.

interviewerId

string

Defaults to 123456

The User ID of the interviewer in the Apploi platform. This field must be an integer string value. Non-integer string characters are not allowed. This is the user ID of a team member recorded in the Apploi platform. Reaching out to the Apploi support team may be the best way to get the correct user ID for the interviewer.

Examples: "123456", "789012", etc.

interviewerTeamId

string

Defaults to 345678

The Team ID of the interviewer in the Apploi platform. This field is only required when the interviewerId is not available. This field must be an integer string value. Non-integer string characters are not allowed. This is the team ID of a team member recorded in the Apploi platform. Reaching out to the Apploi support team may be the best way to get the correct team ID for the interviewer.

Examples: "345678", "987898", etc.

location

string

Defaults to Virtual

The location of the interview. The only restriction on this field is that it must be a string. This allows for specifying a physical location, a virtual location, or any other type of location.

Examples: "123 Main St, New York, NY 10001", "Virtual", "https://meet.google.com/abc-123-xyz", etc.

timezone

string

required

Defaults to America/New_York

The timezone of the interview date and time. The timezone must be a valid timezone string as defined by the IANA Time Zone Database. This timezone will override any timezone information specified in the date field.

Examples: "America/New_York", "Europe/London", "Asia/Tokyo", etc.

Responses

403

Invalid Token

404

Not Found

405

405 response

200200 response

400400 response

500500 response