POST Add a Track Applicant

This API allows you to create an applicant in a track either in invite mode or direct mode.

Request URL

POST /tracks/<track_id>/applicants

Body Parameters

{
    "invite_applicant": "boolean",
    "name": "string",
    "email": "string",
    "send_email": "boolean",
    "email_message": "string",
    "destination_stage_id": "string",
    "fields": [ ]
}

Warning

You must include your API key in the request headers.

Parameters

Parameter	Type	Description
track_id	integer	ID of the track where the applicant should be created.
invite_applicant	boolean	true creates a pending invitation. false (default) creates a completed applicant.
name	string	Applicant name. Required in both invite and direct mode.
email	string	Applicant email. Required in both invite and direct mode.
send_email	boolean	Used in invite mode. When true, invite email is sent to the applicant.
email_message	string	Optional custom message included in invite email.
destination_stage_id | string		Optional stage where direct applicant should be placed. Defaults to first stage.
fields	array/object	Applicant field values for direct mode. Can be a list of id/label + value entries or a key-value map.

Response

201 Created - Applicant created successfully.

Example:

{
    "track_id": "integer",
    "application_id": "integer",
    "candidate_id": "integer",
    "name": "string",
    "email": "string",
    "invite_status": "string",
    "mode": "string",
    "invite_link": "string",
    "email_sent": "boolean",
    "current_stage": { }
}

Error Responses

{
    "error": "string"
}

Status Code	Error	Description
400 Bad Request	Invalid request body	Missing or invalid fields in the request.
401 Unauthorized	Missing or invalid API key	API key is missing or invalid.
404 Not Found	Track not found	The specified track does not exist.
409 Conflict	State conflict	Applicant already exists or operation is not allowed.

Note

In invite mode, only name and email are required. In direct mode, required track fields must be submitted.