Skip to main content
POST
Schedule an interview

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Path Parameters

id
string
required

Body

application/json
kind
enum<string>
required
Available options:
screening,
technical,
behavioral,
onsite,
other
at
string<date-time>
required

Scheduled start, as an ISO 8601 date-time.

durationMinutes
integer
default:60
Required range: 5 <= x <= 1440
location
string
default:""
Maximum string length: 500
notes
string
default:""
Maximum string length: 5000

Response

The updated application.

id
string
required

The ID of the application.

company
string
required

The company applied to.

Minimum string length: 1
role
string
required

The role / job title.

Minimum string length: 1
location
string | null
required
salary
string | null
required
status
enum<string>
required

The current pipeline stage. closed ends it, with a reason.

Available options:
saved,
applied,
screening,
interview,
offer,
closed
closedReason
enum<string> | null
required

Why a closed application ended: not-selected, withdrew, accepted-other or no-response.

Available options:
not-selected,
withdrew,
accepted-other,
no-response
resumeId
string | null
required

The linked Reactive Resume, if any.

coverLetterId
string | null
required

The linked saved cover letter, if any.

sentResumeVersionId
string | null
required

The version of the linked resume saved when the application was sent (reached Applied).

sentCheckScore
integer | null
required

The resume's Check score when it was sent, out of 100.

Required range: -9007199254740991 <= x <= 9007199254740991
sentCoverLetterVersionId
string | null
required

The version of the linked letter saved when the application was sent.

source
string | null
required
tags
string[]
required
sourceUrl
string<uri> | null
required
jobDescription
string | null
required
Maximum string length: 20000
postingSource
object | null
required
requirements
string[]
required

What the posting asks for, as read when the application was added.

matchScore
integer | null
required
Required range: 0 <= x <= 100
aiMetadata
object | null
required
notes
string | null
required
resumeFileUrl
string | null
required
resumeFileName
string | null
required
coverLetterUrl
string | null
required
coverLetterName
string | null
required
followUpAt
string<date-time> | null
required
followUpNote
string | null
required
contacts
object[]
required
activity
object[]
required
appliedAt
string<date-time>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required