Skip to content

Create Candidates

Endpoint

http
POST /unified/ats/candidates
Integrations supported
  • Lever

Query parameters

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
job_id
string
The job's unique identifier
Required in
  • Lever
application_source
string
Specifies whether the candidate is being created by the applicant (from Job Boards, Public Job Site, etc.) or being added as a lead by a user
All possible enum values:
  • applicant
  • lead
Supported in
  • Lever

Request Body

Refer Writing data using Unified APIs

first_name
string
The candidate's first_name
Supported in
  • Lever
last_name
string
The candidate's last_name
Supported in
  • Lever
title
string
The candidate's title
Supported in
  • Lever
company
string
The candidate's company
Supported in
  • Lever
locations
string[]
The candidate's locations
Supported in
  • Lever
phones
object[]
The candidate's phone numbers
Supported in
  • Lever
number
string
The candidate's phone number
type
string
The candidate's phone number type
emails
object[]
The candidate's emails
Supported in
  • Lever
email
string
The candidate's email
type
string
The candidate's email type
links
Supported in
  • Lever
tags
string[]
The candidate's tags
Supported in
  • Lever
attachments
object[]
The candidate's attachments
Supported in
  • Lever
id
string
REQUIRED · The attachment's unique identifier
file_name
string
The attachment's file_name
file_url
string
The attachment's file_url
candidate
object
The attachment's candidate
id
string
Unique identifier of the candidate
application
object
The attachment's application
id
string
Unique identifier of the application
job
object
The attachment's job
id
string
Unique identifier of the job
attachment_type
string
The attachment's type
created_at
string · date-time
The date and time of the attachment's creation
updated_at
string · date-time
The date and time of the attachment's last update
url
string
The url of the attachment
type
string
The type of the attachment. If resume, set the value to `resume`, else leave it blank.
job_form_field_answers
object[]
Required in
  • Lever
name
string
The name of the job_form_field
value
string
The value for the job_form_field
group_id
string
The group_id of the job_form_field
remote_data
object
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body

id
string
REQUIRED · The candidate's unique identifier
Supported in
  • Lever
first_name
string
The candidate's first_name
Supported in
  • Lever
last_name
string
The candidate's last_name
Supported in
  • Lever
name
string
The user's full name
Supported in
  • Lever
company
string
The candidate's company
Supported in
  • Lever
title
string
The candidate's title
last_interaction_at
string
The candidate's last_interaction date
Supported in
  • Lever
is_private
string
Whether the candidate is_private
Supported in
  • Lever
can_email
boolean
Whether the candidate can email
locations
string[]
The candidate's locations
Supported in
  • Lever
phones
object[]
The candidate's phone numbers
Supported in
  • Lever
number
string
The candidate's phone number
type
string
The candidate's phone number type
emails
object[]
The candidate's emails
Supported in
  • Lever
email
string
The candidate's email
type
string
The candidate's email type
urls
object[]
The candidate's urls
Supported in
  • Lever
url
string
The candidate's URL
type
string
The candidate's URL type
tags
string[]
The candidate's tags
Supported in
  • Lever
applications
object[]
The candidate's applications
Supported in
  • Lever
id
string
The application's unique identifier
candidate
object
The application's candidate
id
string
Unique identifier of the candidate
job
object
The application's job
id
string
Unique identifier of the job
applied_at
string · date-time
The date and time of the application's creation
rejected_at
string · date-time
The date and time of the application's rejection
source
object
The application's source
id
string
The application's source's unique identifier
name
string
The application's source's name
credited_to
object
The application's credited_to
id
string
Unique identifier of the user
first_name
string
First name of the user
last_name
string
Last name of the user
emails
object[]
email
string
Email of the user
type
string
Type of the email
is_primary
boolean
Whether the email is primary
current_stage
object
The application's current_stage
id
string
The application's current_stage's unique identifier
name
string
The application's current_stage's name
job
object
The application's current_stage's job
id
string
Unique identifier of the job
created_at
string · date-time
The date and time of the application's current_stage's creation
updated_at
string · date-time
The date and time of the application's current_stage's last update
reject_reason
string
The application's reject_reason
attachments
object[]
The application's attachments
id
string
REQUIRED · The attachment's unique identifier
file_name
string
The attachment's file_name
file_url
string
The attachment's file_url
candidate
object
The attachment's candidate
id
string
Unique identifier of the candidate
application
object
The attachment's application
id
string
Unique identifier of the application
job
object
The attachment's job
id
string
Unique identifier of the job
attachment_type
string
The attachment's type
created_at
string · date-time
The date and time of the attachment's creation
updated_at
string · date-time
The date and time of the attachment's last update
created_at
string · date-time
The date and time of the application's creation
updated_at
string · date-time
The date and time of the application's last update
attachments
object[]
The candidate's attachments
id
string
REQUIRED · The attachment's unique identifier
file_name
string
The attachment's file_name
file_url
string
The attachment's file_url
candidate
object
The attachment's candidate
id
string
Unique identifier of the candidate
application
object
The attachment's application
id
string
Unique identifier of the application
job
object
The attachment's job
id
string
Unique identifier of the job
attachment_type
string
The attachment's type
created_at
string · date-time
The date and time of the attachment's creation
updated_at
string · date-time
The date and time of the attachment's last update
created_at
string · date-time
The date and time of the phone number's creation
Supported in
  • Lever
updated_at
string · date-time
The date and time of the phone number's last update
Supported in
  • Lever
remote_data
object
Raw data returned from the remote API call.