> This page is for API, version 2026-01-01 (Stable) (default).
> For other versions, use one of these documentation indexes:
> - 2026-01-01 (Stable) (default): https://developer.deel.com/api/stable/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.deel.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server.

# Generate a preview of an ATS email template

GET https://api.letsdeel.com/rest/ats/email-templates/{email_template_id}/preview

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.

Reference: https://developer.deel.com/api/reference/endpoints/ats/retrieve-ats-email-template-preview-v-2026-10-28

## Authentication

- `Authorization` header (bearer token, required) — ## 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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
- `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

## Servers

- `https://api.letsdeel.com/rest` (Production, default)
- `https://api-staging.letsdeel.com/rest` (Demo)

## Request

### Path parameters

- `email_template_id` (string, required) — Email template ID, as returned by the email templates list endpoint. Only published templates can be previewed.

### Query parameters

- `application_id` (string, required) — Application whose candidate, job and most recent offer fill the placeholders.

### Headers

- `X-Beta` (enum, required, default: true) — Opts in to the beta version of this endpoint. Must be `true`.
  - Allowed values: `true`

## Response

### 200

Rendered email template

- `data` (AtsEmailTemplatesEmailTemplateIdPreviewGetResponsesContentApplicationJsonSchemaData, required)

## Errors

### 400 Bad Request Error

Operation failed.

- `errors` (list of AtsEmailTemplatesEmailTemplateIdPreviewGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

### 401 Unauthorized Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

### 403 Forbidden Error

Forbidden. ATS is not enabled for this organization or insufficient permissions.

- `errors` (list of AtsEmailTemplatesEmailTemplateIdPreviewGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

### 404 Not Found Error

Not found, or not visible to the authenticated user. The two cases are indistinguishable.

- `errors` (list of AtsEmailTemplatesEmailTemplateIdPreviewGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

### 500 Internal Server Error

Operation failed.

- `errors` (list of AtsEmailTemplatesEmailTemplateIdPreviewGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

## Types

### AtsEmailTemplatesEmailTemplateIdPreviewGetResponsesContentApplicationJsonSchemaData

- `body` (string, required) — Rendered body as sanitized HTML. Unresolved placeholders are left in place.
- `subject` (string, required) — Rendered subject as plain text. Unresolved placeholders are left in place.
- `unresolved_placeholders` (list of string, required) — Distinct placeholders that could not be filled, as they appear in the text. interview.*, questionnaire.link, document.*, application_form.link and referrer.fullName are only supplied when the email is sent, so they are always listed.

### AtsEmailTemplatesEmailTemplateIdPreviewGetResponsesContentApplicationJsonSchemaErrorsItems

- `code` (string, required) — Machine-readable error code
- `message` (string, required) — Human-readable error message
- `field` (string, optional) — Request field related to the error, if applicable

### ApiErrorRequest

- `method` (string, optional) — The HTTP method of the failed request
- `url` (string, optional) — The relative URL of the failed request
- `status` (double, optional) — The status code of the response
- `api_req_id` (string, optional) — The request ID of the failed request
- `docs` (string, optional) — A link to the official documentation for the requested endpoint resource
- `source` (string, optional) — The source handler which produced the returned error
- `code` (double, optional) — The code of the source handler which produced the returned error

### ApiError

- `message` (string, optional) — A description of the returned error
- `path` (string, optional) — The JSON path where input validation failed

## Examples

**Response**

```json
{
  "data": {
    "body": "<p>Hi Jane, please pick a slot: ${{interview.bookingLink}}</p>",
    "subject": "Next steps for Senior Backend Engineer",
    "unresolved_placeholders": [
      "${{interview.bookingLink}}"
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.letsdeel.com/rest/ats/email-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479/preview"

querystring = {"application_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}

headers = {
    "X-Beta": "true",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.letsdeel.com/rest/ats/email-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479/preview?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479';
const options = {method: 'GET', headers: {'X-Beta': 'true', Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.letsdeel.com/rest/ats/email-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479/preview?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Beta", "true")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/ats/email-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479/preview?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Beta"] = 'true'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.letsdeel.com/rest/ats/email-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479/preview?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479")
  .header("X-Beta", "true")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.letsdeel.com/rest/ats/email-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479/preview?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Beta' => 'true',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/ats/email-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479/preview?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Beta", "true");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Beta": "true",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/ats/email-templates/f47ac10b-58cc-4372-a567-0e02b2c3d479/preview?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```