Deel: Create ATS Candidate
Deel atsCandidates.createAtsCandidate: arguments, response, policy and SDK examples.
← ATS candidates operations · Get started
Operation deel.atscandidates_createatscandidate_v2026_01_01
Provider route: POST /ats/candidates. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["atsCandidates"]["createAtsCandidate"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.atsCandidates.createAtsCandidate(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.ats_candidates.create_ats_candidate(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create ATS Candidate — request body — body data |
Referenced models: Create ATS Candidate — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create ATS Candidate — 200 response body |
Referenced models: Create ATS Candidate — 200 response body
Schemas
Section titled “Schemas”Create ATS Candidate — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string or null | Optional | City the candidate currently lives in |
country_code | string or null | Optional | ISO 3166-1 alpha-2 code of the country the candidate currently lives in |
email | string | Required within parent | The candidate's email address Format: email |
first_name | string | Required within parent | The candidate's first name |
last_name | string | Required within parent | The candidate's last name |
linkedin_profile_url | string or null | Optional | The candidate's LinkedIn profile URL Format: uri |
origin_source_slug | string | Optional | The candidate's origin source slug. Accepts any active source slug of the organization, e.g. sourced_internally, sourced_externally, external_career_page, linkedin_basic or a custom source slug (case-insensitive) |
phone_number | string or null | Optional | The candidate's phone number |
pic_url | string or null | Optional | The candidate's picture URL Format: uri |
Create ATS Candidate — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create ATS Candidate — 200 response body — data |
Referenced models: Create ATS Candidate — 200 response body — data
Create ATS Candidate — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
anonymized_at | JSON | Optional | |
anonymized_at (anyOf 1) | string | Alternative | Timestamp when the candidate was anonymized Format: date-time |
anonymized_at (anyOf 2) | null | Alternative | Timestamp when the candidate was anonymized Format: date-time |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City the candidate currently lives in |
city (anyOf 2) | null | Alternative | City the candidate currently lives in |
country_code | JSON | Optional | |
country_code (anyOf 1) | string | Alternative | ISO 3166-1 alpha-2 country the candidate currently lives in |
country_code (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country the candidate currently lives in |
created_at | string | Required within parent | Timestamp when the candidate was created Format: date-time |
email | string | Required within parent | Email address of the candidate Format: email |
final_archivation_at | JSON | Optional | |
final_archivation_at (anyOf 1) | string | Alternative | Timestamp when the candidate was finally archived Format: date-time |
final_archivation_at (anyOf 2) | null | Alternative | Timestamp when the candidate was finally archived Format: date-time |
first_name | string | Required within parent | First name of the candidate |
id | string | Required within parent | Unique identifier for the candidate Format: uuid |
import_session_id | JSON | Optional | |
import_session_id (anyOf 1) | string | Alternative | Import session identifier |
import_session_id (anyOf 2) | null | Alternative | Import session identifier |
imported_id | JSON | Optional | |
imported_id (anyOf 1) | string | Alternative | Imported identifier |
imported_id (anyOf 2) | null | Alternative | Imported identifier |
last_name | string | Required within parent | Last name of the candidate |
linkedin_profile_url | JSON | Optional | |
linkedin_profile_url (anyOf 1) | string | Alternative | LinkedIn profile URL of the candidate |
linkedin_profile_url (anyOf 2) | null | Alternative | LinkedIn profile URL of the candidate |
numeric_id | JSON | Required within parent | |
numeric_id (anyOf 1) | integer | Alternative | Numeric identifier for the candidate |
numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
origin_source_slug | JSON | Optional | |
origin_source_slug (anyOf 1) | string | Alternative | Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug) |
origin_source_slug (anyOf 2) | null | Alternative | Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug) |
phone_number | JSON | Optional | |
phone_number (anyOf 1) | string | Alternative | Phone number of the candidate |
phone_number (anyOf 2) | null | Alternative | Phone number of the candidate |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | Profile picture URL of the candidate |
pic_url (anyOf 2) | null | Alternative | Profile picture URL of the candidate |
source | JSON | Optional | |
source (anyOf 1) | string | Alternative | Source of the candidate |
source (anyOf 2) | null | Alternative | Source of the candidate |
updated_at | string | Required within parent | Timestamp when the candidate was last updated Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.atscandidates_createatscandidate_v2026_01_01. Catalog operation: atscandidates_createatscandidate_v2026_01_01. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["ats:write", "worker:write"]
Pinned headers: {"X-Version": "2026-01-01"}