List email drafts to a candidate as they would be sent | Deel

curl -G https://api.letsdeel.com/rest/ats/candidates/faac641e-a484-4875-aed5-bfcb0a0691a0/email-drafts \
     -H "X-Beta: true" \
     -H "Authorization: Bearer <token>" \
     -d application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479

{
  "data": [
    {
      "cc": [
        "ada.lovelace@example.com"
      ],
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "to": [
        "ada.lovelace@example.com"
      ],
      "bcc": [
        "ada.lovelace@example.com"
      ],
      "body": "<p>Hi Ada, thanks for your time today.</p>",
      "from": "Grace Hopper <grace.hopper@acme.com>",
      "subject": "Next steps for the Data Engineer role",
      "updated_at": "2026-10-23T10:30:00.000Z",
      "attachments": [
        {
          "id": "c2d3e4f5-a6b7-8901-bcde-f12345678901",
          "file_name": "interview-guide.pdf"
        }
      ],
      "application_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "unresolved_placeholders": [
        "${{interview.bookingLink}}"
      ]
    }
  ],
  "has_more": false,
  "next_cursor": "string",
  "total_count": 1
}

Previews the email drafts the authenticated user wrote to a candidate, rendered exactly as sending them would produce. Read it before sending a draft, so the user confirms the final content and recipients.

Token scopes: ats:read, worker:read

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-30.

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.deel.training/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

candidate_idstringRequiredformat: "uuid"

ID of the candidate the drafts are addressed to

Query parameters

application_idstringOptionalformat: "uuid"

Only drafts about this application of the candidate. Required unless the caller is an ATS admin, since access to emails is granted per job.

Response

The caller's email drafts to the candidate

datalist of objects

The caller's own drafts to the candidate, most recently changed first, rendered as they would be sent

has_moreboolean

Whether the caller has more drafts to the candidate than the page holds

next_cursorstring or null

Always null: the most recently changed drafts are returned in a single page.

total_countinteger

Number of the caller's drafts to the candidate

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Authentication

Path parameters

Headers

Query parameters

Response

Errors