Skip to main content
POST
Create an interview

Authorizations

Authorization
string
header
required

Provide the API key issued to you by your organization admin. Send it as Authorization: Bearer <api-key> on every request.

Body

application/json
candidate_email
string<email>
required

Candidate's email. Used as the interview attendee.

candidate_name
string
required

Candidate's full name. Used to build the interview title.

Minimum string length: 1

Public URL to the candidate's CV (PDF or DOCX). Plain HTTPS links and Google Drive sharing links are both supported.

qodeJobId
string
required

Job identifier returned by GET /jobs. Determines which interview template (questions, language, intro/outro) is used.

Minimum string length: 1

Response

Interview created. PTP has scheduled the interview and a candidate-facing link is returned.

success
boolean
Example:

true

data
object