POST
/
ats
/
candidate

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connection-token
string
required

The connection token

Query Parameters

remote_data
boolean

Set to true to include data from the original Ats software.

Body

application/json
first_name
string

The first name of the candidate

last_name
string

The last name of the candidate

company
string

The company of the candidate

title
string

The title of the candidate

locations
string

The locations of the candidate

is_private
boolean

Whether the candidate is private

email_reachable
boolean

Whether the candidate is reachable by email

remote_created_at
string

The remote creation date of the candidate

remote_modified_at
string

The remote modification date of the candidate

last_interaction_at
string

The last interaction date with the candidate

attachments
string[]

The attachments UUIDs of the candidate

applications
string[]

The applications UUIDs of the candidate

tags
string[]

The tags of the candidate

urls
object[]

The urls of the candidate, possible values for Url type are WEBSITE, BLOG, LINKEDIN, GITHUB, or OTHER

phone_numbers
object[]

The phone numbers of the candidate

email_addresses
object[]

The email addresses of the candidate

field_mappings
object
required

Response

201 - application/json
first_name
string

The first name of the candidate

last_name
string

The last name of the candidate

company
string

The company of the candidate

title
string

The title of the candidate

locations
string

The locations of the candidate

is_private
boolean

Whether the candidate is private

email_reachable
boolean

Whether the candidate is reachable by email

remote_created_at
string

The remote creation date of the candidate

remote_modified_at
string

The remote modification date of the candidate

last_interaction_at
string

The last interaction date with the candidate

attachments
string[]

The attachments UUIDs of the candidate

applications
string[]

The applications UUIDs of the candidate

tags
string[]

The tags of the candidate

urls
object[]

The urls of the candidate, possible values for Url type are WEBSITE, BLOG, LINKEDIN, GITHUB, or OTHER

phone_numbers
object[]

The phone numbers of the candidate

email_addresses
object[]

The email addresses of the candidate

field_mappings
object
required
id
string

The UUID of the candidate

remote_id
string

The id of the candidate in the context of the 3rd Party

remote_data
object
required
created_at
object
required
modified_at
object
required

Was this page helpful?