Skip to content

Deel: Add Candidate

Deel candidates.addCandidate: arguments, response, policy and SDK examples.

← Candidates operations · Get started

Operation deel.candidates_addcandidate_v2026_01_01

Provider route: POST /candidates. Alter supplies the connection’s credentials and routing.

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["candidates"]["addCandidate"]>[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.candidates.addCandidate(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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.candidates.add_candidate(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelRequired within parentExpand Add Candidate — request body — body data
Details of candidate to create

Referenced models: Add Candidate — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Add Candidate — 201 response body

Referenced models: Add Candidate — 201 response body

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
Add Candidate — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add Candidate — 201 response body — data

Referenced models: Add Candidate — 201 response body — data

Add Candidate — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
createdbooleanRequired within parentIndicates if the candidate was created successfully.

SDK function policy ID: deel.candidates_addcandidate_v2026_01_01. Catalog operation: candidates_addcandidate_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: ["candidates:write"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

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.