Skip to content

Deel: Create an email draft to a candidate

Deel ats.createCandidateEmailDraft: arguments, response, policy and SDK examples.

← ATS operations · Get started

Operation deel.ats_createcandidateemaildraft_v2026_11_02

Provider route: POST /ats/candidates/{candidate_id}/email-drafts. 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["ats"]["createCandidateEmailDraft"]>[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.ats.createCandidateEmailDraft(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.ats.create_candidate_email_draft(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.candidate_idstringRequired within parentFormat: uuid
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true
bodyobjectOptional
body.dataModelRequired within parentExpand Create an email draft to a candidate — request body — body data

Referenced models: Create an email draft to a 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 Create an email draft to a candidate — 201 response body

Referenced models: Create an email draft to a candidate — 201 response body

Create an email draft to a candidate — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
application_idstringOptionalThe application of the candidate the draft is about. Required unless the caller is an ATS admin, since access to emails is granted per job.
Format: uuid
bccarrayOptionalBCC recipients. Each entry is an email address, or a dynamic recipient resolved when the draft is rendered: CANDIDATE, HIRING_MEMBERS, INTERVIEWERS, RECRUITERS or HIRING_MANAGERS.
bcc[]stringEach item
bodystringRequired within parentThe rich text HTML body. May contain placeholders, filled when the draft is rendered.
ccarrayOptionalCC recipients. Each entry is an email address, or a dynamic recipient resolved when the draft is rendered: CANDIDATE, HIRING_MEMBERS, INTERVIEWERS, RECRUITERS or HIRING_MANAGERS.
cc[]stringEach item
subjectstringRequired within parentThe subject. May contain placeholders such as ${{candidate.firstName}}, filled when the draft is rendered.
Maximum length: 1000
toarrayRequired within parentPrimary recipients. Each entry is an email address, or a dynamic recipient resolved when the draft is rendered: CANDIDATE, HIRING_MEMBERS, INTERVIEWERS, RECRUITERS or HIRING_MANAGERS.
to[]stringEach item
Create an email draft to a candidate — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create an email draft to a candidate — 201 response body — data
The new draft, rendered as it would be sent

Referenced models: Create an email draft to a candidate — 201 response body — data

Create an email draft to a candidate — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRootThe new draft, rendered as it would be sent
application_idJSONRequired within parent
application_id (anyOf 1)stringAlternativeThe application the draft is about, or null for a draft about the candidate only
Format: uuid
application_id (anyOf 2)nullAlternativeThe application the draft is about, or null for a draft about the candidate only
Format: uuid
attachmentsarrayRequired within parentFiles attached to the draft
attachments[]ModelEach itemExpand Create an email draft to a candidate — 201 response body — data attachments item
bccarrayRequired within parentBCC recipients, resolved to addresses
bcc[]stringEach itemFormat: email
bodystringRequired within parentThe rich text HTML body with its placeholders filled in
ccarrayRequired within parentCC recipients, resolved to addresses
cc[]stringEach itemFormat: email
fromstringRequired within parentThe sender the email goes out as: the author's connected mailbox when they have one, otherwise the organization's sender
idstringRequired within parentThe unique identifier of the email draft
Format: uuid
subjectstringRequired within parentThe subject with its placeholders filled in
toarrayRequired within parentPrimary recipients, with dynamic recipients such as the candidate resolved to addresses
to[]stringEach itemFormat: email
unresolved_placeholdersarrayRequired within parentPlaceholders left unfilled in the subject or body. The draft cannot be sent while any remain.
unresolved_placeholders[]stringEach item
updated_atstringRequired within parentThe timestamp when the draft was last changed
Format: date-time

Referenced models: Create an email draft to a candidate — 201 response body — data attachments item

Create an email draft to a candidate — 201 response body — data attachments item
FieldTypePresenceDescription and constraints
$objectRoot
file_namestringRequired within parentThe name of the attached file
idstringRequired within parentThe unique identifier of the attachment
Format: uuid

SDK function policy ID: deel.ats_createcandidateemaildraft_v2026_11_02. Catalog operation: ats_createcandidateemaildraft_v2026_11_02. 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-11-02"}

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.