Skip to content

Deel: Add Candidate — request body — body data

Add Candidate: request body, field body / data. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Add Candidate — request body — body data

FieldTypePresenceDescription and constraints
$objectRootDetails of candidate to create
countrystringOptionalCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
emailstringOptionalWorker’s work email address.
Format: email
Minimum length: 5
first_namestringRequired within parentCandidate’s first name.
idstringRequired within parentUnique identifier of candidate in your ATS.
job_titlestringOptionalJob Title.
last_namestringRequired within parentCandidate’s last name.
linkstringRequired within parentLink to candidate’s profile in ATS.
nationalitystringOptionalNationality of the worker.
Maximum length: 2
Minimum length: 2
personal_emailstringOptionalWorker’s personal email address.
Format: email
Minimum length: 5
start_datestringRequired within parentShort date in format ISO-8601 (YYYY-MM-DD).
Format: date
statestringOptionalJob location state.
Maximum length: 50
Minimum length: 1
statusstringRequired within parentOffer status
One of: offer-accepted, offer-sent, offer-declined, offer-deleted

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.