Skip to content

Deel: Create ATS Candidate — 200 response body — data

Create ATS Candidate: 200 response body, field data. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Create ATS Candidate — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
anonymized_atJSONOptional
anonymized_at (anyOf 1)stringAlternativeTimestamp when the candidate was anonymized
Format: date-time
anonymized_at (anyOf 2)nullAlternativeTimestamp when the candidate was anonymized
Format: date-time
cityJSONOptional
city (anyOf 1)stringAlternativeCity the candidate currently lives in
city (anyOf 2)nullAlternativeCity the candidate currently lives in
country_codeJSONOptional
country_code (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country the candidate currently lives in
country_code (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country the candidate currently lives in
created_atstringRequired within parentTimestamp when the candidate was created
Format: date-time
emailstringRequired within parentEmail address of the candidate
Format: email
final_archivation_atJSONOptional
final_archivation_at (anyOf 1)stringAlternativeTimestamp when the candidate was finally archived
Format: date-time
final_archivation_at (anyOf 2)nullAlternativeTimestamp when the candidate was finally archived
Format: date-time
first_namestringRequired within parentFirst name of the candidate
idstringRequired within parentUnique identifier for the candidate
Format: uuid
import_session_idJSONOptional
import_session_id (anyOf 1)stringAlternativeImport session identifier
import_session_id (anyOf 2)nullAlternativeImport session identifier
imported_idJSONOptional
imported_id (anyOf 1)stringAlternativeImported identifier
imported_id (anyOf 2)nullAlternativeImported identifier
last_namestringRequired within parentLast name of the candidate
linkedin_profile_urlJSONOptional
linkedin_profile_url (anyOf 1)stringAlternativeLinkedIn profile URL of the candidate
linkedin_profile_url (anyOf 2)nullAlternativeLinkedIn profile URL of the candidate
numeric_idJSONRequired within parent
numeric_id (anyOf 1)integerAlternativeNumeric identifier for the candidate
numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
origin_source_slugJSONOptional
origin_source_slug (anyOf 1)stringAlternativeOrigin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug)
origin_source_slug (anyOf 2)nullAlternativeOrigin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug)
phone_numberJSONOptional
phone_number (anyOf 1)stringAlternativePhone number of the candidate
phone_number (anyOf 2)nullAlternativePhone number of the candidate
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeProfile picture URL of the candidate
pic_url (anyOf 2)nullAlternativeProfile picture URL of the candidate
sourceJSONOptional
source (anyOf 1)stringAlternativeSource of the candidate
source (anyOf 2)nullAlternativeSource of the candidate
updated_atstringRequired within parentTimestamp when the candidate was last updated
Format: date-time

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.