Deel: List email drafts to a candidate as they would be sent
Deel ats.listCandidateEmailDraftPreviews: arguments, response, policy and SDK examples.
← ATS operations · Get started
Operation deel.ats_listcandidateemaildraftpreviews_v2026_11_02
Provider route: GET /ats/candidates/{candidate_id}/email-drafts. 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["ats"]["listCandidateEmailDraftPreviews"]>[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.listCandidateEmailDraftPreviews(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.list_candidate_email_draft_previews(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.candidate_id | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.application_id | string | Optional | Format: uuid |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
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 List email drafts to a candidate as they would be sent — 200 response body |
Referenced models: List email drafts to a candidate as they would be sent — 200 response body
Schemas
Section titled “Schemas”List email drafts to a candidate as they would be sent — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The caller's own drafts to the candidate, most recently changed first, rendered as they would be sent |
data[] | Model | Each item | Expand List email drafts to a candidate as they would be sent — 200 response body — data item |
has_more | boolean | Required within parent | Whether the caller has more drafts to the candidate than the page holds |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Always null: the most recently changed drafts are returned in a single page. |
next_cursor (anyOf 2) | null | Alternative | Always null: the most recently changed drafts are returned in a single page. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Number of the caller's drafts to the candidate |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List email drafts to a candidate as they would be sent — 200 response body — data item
List email drafts to a candidate as they would be sent — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_id | JSON | Required within parent | |
application_id (anyOf 1) | string | Alternative | The application the draft is about, or null for a draft about the candidate only Format: uuid |
application_id (anyOf 2) | null | Alternative | The application the draft is about, or null for a draft about the candidate only Format: uuid |
attachments | array | Required within parent | Files attached to the draft |
attachments[] | Model | Each item | Expand Create an email draft to a candidate — 201 response body — data attachments item |
bcc | array | Required within parent | BCC recipients, resolved to addresses |
bcc[] | string | Each item | Format: email |
body | string | Required within parent | The rich text HTML body with its placeholders filled in |
cc | array | Required within parent | CC recipients, resolved to addresses |
cc[] | string | Each item | Format: email |
from | string | Required within parent | The sender the email goes out as: the author's connected mailbox when they have one, otherwise the organization's sender |
id | string | Required within parent | The unique identifier of the email draft Format: uuid |
subject | string | Required within parent | The subject with its placeholders filled in |
to | array | Required within parent | Primary recipients, with dynamic recipients such as the candidate resolved to addresses |
to[] | string | Each item | Format: email |
unresolved_placeholders | array | Required within parent | Placeholders left unfilled in the subject or body. The draft cannot be sent while any remain. |
unresolved_placeholders[] | string | Each item | |
updated_at | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_name | string | Required within parent | The name of the attached file |
id | string | Required within parent | The unique identifier of the attachment Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.ats_listcandidateemaildraftpreviews_v2026_11_02. Catalog operation: ats_listcandidateemaildraftpreviews_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:read", "worker:read"]
Pinned headers: {"X-Version": "2026-11-02"}