Skip to navigation
EndpointsAts

Generate a preview of an ATS email template

Beta

Renders a published email template for one application, filling its placeholders with the candidate’s, job’s and sender’s data, and reports any placeholder it could not fill. Use it to check an email before sending it to a candidate. Nothing is sent or saved.

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-28.

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.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

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

Path parameters

email_template_idstringRequiredformat: "uuid"
Email template ID, as returned by the email templates list endpoint. Only published templates can be previewed.

Headers

X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Query parameters

application_idstringRequiredformat: "uuid"
Application whose candidate, job and most recent offer fill the placeholders.

Response

Rendered email template
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error