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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of candidate to create |
country | string | Optional | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
email | string | Optional | Worker’s work email address. Format: email Minimum length: 5 |
first_name | string | Required within parent | Candidate’s first name. |
id | string | Required within parent | Unique identifier of candidate in your ATS. |
job_title | string | Optional | Job Title. |
last_name | string | Required within parent | Candidate’s last name. |
link | string | Required within parent | Link to candidate’s profile in ATS. |
nationality | string | Optional | Nationality of the worker. Maximum length: 2 Minimum length: 2 |
personal_email | string | Optional | Worker’s personal email address. Format: email Minimum length: 5 |
start_date | string | Required within parent | Short date in format ISO-8601 (YYYY-MM-DD). Format: date |
state | string | Optional | Job location state. Maximum length: 50 Minimum length: 1 |
status | string | Required within parent | Offer status One of: offer-accepted, offer-sent, offer-declined, offer-deleted |