/candidates

Creates a Candidate object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.

Usage Example

Fetch from the LIST Candidates endpoint and filter by ID to show all candidates.

# The Candidate Object ### Description The `Candidate` object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications. ### Usage Example Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all candidates.

remote_user_idstringRequired

Response

modelobject

Description

The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.

Usage Example

Fetch from the LIST Candidates endpoint and filter by ID to show all candidates.

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

locationslist of strings or nullOptional

The candidate's locations.

email_addresseslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

applicationslist of stringsRequired

Array of Application object IDs.

remote_idstring or nullOptional

The third-party API ID of the matching object.

last_namestring or nullOptional

The candidate's last name.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

last_namestring or nullOptional

The candidate's last name.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

applicationslist of stringsRequired

Array of Application object IDs.

remote_idstring or nullOptional

The third-party API ID of the matching object.

last_namestring or nullOptional

The candidate's last name.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

applicationslist of stringsRequired

Array of Application object IDs.

remote_idstring or nullOptional

The third-party API ID of the matching object.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

tagslist of stringsOptional

Array of Tag names as strings.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

phone_numberslist of objectsRequired

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

last_namestring or nullOptional

The candidate's last name.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

is_privateboolean or nullOptional

Whether or not the candidate is private.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

remote_datalist of objects or nullOptionalRead-only

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

applicationslist of stringsRequired

Array of Application object IDs.

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The candidate's first name.

last_namestring or nullOptional

The candidate's last name.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

is_privateboolean or nullOptional

Whether or not the candidate is private.

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The candidate's first name.

last_namestring or nullOptional

The candidate's last name.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

is_privateboolean or nullOptional

Whether or not the candidate is private.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

is_privateboolean or nullOptional

Whether or not the candidate is private.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The candidate's first name.

last_namestring or nullOptional

The candidate's last name.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

phone_numberslist of objectsOptional

urlslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

applicationslist of stringsRequired

Array of Application object IDs.

remote_idstring or nullOptional

The third-party API ID of the matching object.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

phone_numberslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

phone_numberslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

remote_datalist of objects or nullOptionalRead-only

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

locationslist of strings or nullOptional

The candidate's locations.

email_addresseslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

applicationslist of stringsRequired

Array of Application object IDs.

remote_idstring or nullOptional

The third-party API ID of the matching object.

last_namestring or nullOptional

The candidate's last name.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

last_namestring or nullOptional

The candidate's last name.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

applicationslist of stringsRequired

Array of Application object IDs.

remote_idstring or nullOptional

The third-party API ID of the matching object.

last_namestring or nullOptional

The candidate's last name.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

applicationslist of stringsRequired

Array of Application object IDs.

remote_idstring or nullOptional

The third-party API ID of the matching object.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

tagslist of stringsOptional

Array of Tag names as strings.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

phone_numberslist of objectsRequired

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

last_namestring or nullOptional

The candidate's last name.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

is_privateboolean or nullOptional

Whether or not the candidate is private.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

remote_datalist of objects or nullOptionalRead-only

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

applicationslist of stringsRequired

Array of Application object IDs.

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The candidate's first name.

last_namestring or nullOptional

The candidate's last name.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

is_privateboolean or nullOptional

Whether or not the candidate is private.

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The candidate's first name.

last_namestring or nullOptional

The candidate's last name.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

is_privateboolean or nullOptional

Whether or not the candidate is private.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

is_privateboolean or nullOptional

Whether or not the candidate is private.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

locationslist of strings or nullOptional

The candidate's locations.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The candidate's first name.

last_namestring or nullOptional

The candidate's last name.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

can_emailboolean or nullOptional

Whether or not the candidate can be emailed.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

applicationslist of stringsOptional

Array of Application object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

last_interaction_atdatetime or nullOptional

When the most recent interaction with the candidate occurred.

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

urlslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptional

The candidate's current company.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

phone_numberslist of objectsOptional

urlslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

applicationslist of stringsRequired

Array of Application object IDs.

remote_idstring or nullOptional

The third-party API ID of the matching object.

titlestring or nullOptional

The candidate's current title.

remote_created_atdatetime or nullOptional

When the third party's candidate was created.

remote_updated_atdatetime or nullOptional

When the third party's candidate was updated.

phone_numberslist of objectsOptional

urlslist of objectsOptional

tagslist of stringsOptional

Array of Tag names as strings.

attachmentslist of stringsOptional

Array of Attachment object IDs.

Supported POST model parameters

first_namestring or nullRequired

The candidate's first name.

last_namestring or nullRequired

The candidate's last name.

email_addresseslist of objectsRequired

remote_idstring or nullOptional

The third-party API ID of the matching object.

phone_numberslist of objectsOptional

applicationslist of stringsOptional

Array of Application object IDs.

attachmentslist of stringsOptional

Array of Attachment object IDs.

remote_datalist of objects or nullOptionalRead-only

1	from merge import Merge
2	from merge.resources.ats import CandidateRequest
3
4	client = Merge(
5	account_token="YOUR_ACCOUNT_TOKEN",
6	api_key="YOUR_API_KEY",
7	)
8	client.ats.candidates.create(
9	model=CandidateRequest(),
10	remote_user_id="remote_user_id",
11	)

1	{
2	"model": {
3	"id": "521b18c2-4d01-4297-b451-19858d07c133",
4	"remote_id": "21198",
5	"created_at": "2021-09-15T00:00:00Z",
6	"modified_at": "2021-10-16T00:00:00Z",
7	"first_name": "Gil",
8	"last_name": "Feig",
9	"company": "Columbia Dining App.",
10	"title": "Software Engineer",
11	"remote_created_at": "2021-10-15T00:00:00Z",
12	"remote_updated_at": "2021-10-16T00:00:00Z",
13	"last_interaction_at": "2021-10-17T00:00:00Z",
14	"is_private": true,
15	"can_email": true,
16	"locations": [
17	"San Francisco",
18	"New York",
19	"Miami"
20	],
21	"phone_numbers": [
22	{
23	"value": "+1234567890",
24	"phone_number_type": "MOBILE"
25	}
26	],
27	"email_addresses": [
28	{
29	"value": "hello@merge.dev",
30	"email_address_type": "PERSONAL"
31	}
32	],
33	"urls": [
34	{
35	"value": "http://alturl.com/p749b",
36	"url_type": "BLOG"
37	}
38	],
39	"tags": [
40	"High-Priority"
41	],
42	"applications": [
43	"29eb9867-ce2a-403f-b8ce-f2844b89f078",
44	"b4d08e5c-de00-4d64-a29f-66addac9af99",
45	"4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"
46	],
47	"attachments": [
48	"bea08964-32b4-4a20-8bb4-2612ba09de1d"
49	],
50	"remote_was_deleted": true,
51	"field_mappings": {
52	"organization_defined_targets": {
53	"custom_key": "custom_value"
54	},
55	"linked_account_defined_targets": {
56	"custom_key": "custom_value"
57	}
58	},
59	"remote_data": [
60	{
61	"path": "/candidates"
62	}
63	]
64	},
65	"warnings": [
66	{
67	"title": "Unrecognized Field",
68	"detail": "An unrecognized field, age, was passed in with request data.",
69	"problem_type": "UNRECOGNIZED_FIELD",
70	"source": {
71	"pointer": "/age"
72	},
73	"block_merge_link": true
74	}
75	],
76	"errors": [
77	{
78	"title": "Missing Required Field",
79	"detail": "custom_fields is a required field on model.",
80	"problem_type": "MISSING_REQUIRED_FIELD",
81	"source": {
82	"pointer": "/model/custom_fields"
83	},
84	"block_merge_link": true
85	}
86	],
87	"logs": [
88	{
89	"log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
90	"dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
91	"log_summary": {
92	"url": "www.exampleintegration.com/api/v1/exampleapi",
93	"method": "POST",
94	"status_code": 200
95	}
96	}
97	]
98	}

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Description

Usage Example

Description

Usage Example

Field support by integration