Create candidate

Create a new candidate profile in your organization. first_name and last_name are required; all other profile fields are optional. Pass a nested application object to simultaneously create the candidate's first application — supply a job_id to create an applicant, or a prospect_pool_id (and omit job_id) to create a prospect. Tag names that don't yet exist on the organization are created on the fly.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 255
string
required
length ≤ 255
string
length ≤ 255
string
enum
string
string
length ≤ 255
boolean
phone_numbers
array of objects
phone_numbers
addresses
array of objects
addresses
email_addresses
array of objects
email_addresses
website_addresses
array of objects
website_addresses
social_media_addresses
array of objects
social_media_addresses
tags
array of strings
tags
linked_user_ids
array of integers
linked_user_ids
custom_fields
array of objects
custom_fields
application
Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language
Credentials
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json