Skip to content

Deel: Retrieve suggested ATS email templates

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

← ATS operations · Get started

Operation deel.ats_retrieveatsemailtemplatesuggestions_v2026_10_28

Provider route: GET /ats/email-template-suggestions. 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"]["retrieveAtsEmailTemplateSuggestions"]>[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.retrieveAtsEmailTemplateSuggestions(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.retrieve_ats_email_template_suggestions(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.application_idstringOptionalFormat: uuid
query.interview_plan_stage_idstringOptionalFormat: uuid
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve suggested ATS email templates — 200 response body

Referenced models: Retrieve suggested ATS email templates — 200 response body

Retrieve suggested ATS email templates — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve suggested ATS email templates — 200 response body — data

Referenced models: Retrieve suggested ATS email templates — 200 response body — data

Retrieve suggested ATS email templates — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
frequently_usedarrayRequired within parentTemplates the authenticated user sent most often recently, most used first.
frequently_used[]ModelEach itemExpand Retrieve suggested ATS email templates — 200 response body — data frequently used item
stage_suggestionsJSONRequired within parentTemplates the organization sends most at the requested stage. Null when no stage was given or the stage has too little send history to suggest from.
stage_suggestions (anyOf 1)ModelAlternativeExpand Retrieve suggested ATS email templates — 200 response body — data stage suggestions items, stage name
stage_suggestions (anyOf 2)nullAlternative

Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item, Retrieve suggested ATS email templates — 200 response body — data stage suggestions items, stage name

Retrieve suggested ATS email templates — 200 response body — data frequently used item
FieldTypePresenceDescription and constraints
$objectRoot
email_templateModelRequired within parentExpand Retrieve suggested ATS email templates — 200 response body — data frequently used item email template
send_countJSONRequired within parent
send_count (anyOf 1)integerAlternativeHow many times the template was sent in the trailing window
send_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item email template

Retrieve suggested ATS email templates — 200 response body — data stage suggestions items, stage name
FieldTypePresenceDescription and constraints
$objectRootTemplates the organization sends most at the requested stage. Null when no stage was given or the stage has too little send history to suggest from.
itemsarrayRequired within parentSuggested templates, most used first.
items[]ModelEach itemExpand Retrieve suggested ATS email templates — 200 response body — data frequently used item
stage_namestringRequired within parentCustomer-defined stage name

Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item

Retrieve suggested ATS email templates — 200 response body — data frequently used item email template
FieldTypePresenceDescription and constraints
$objectRoot
bodystringRequired within parentEmail body as HTML with ${{token}} placeholders
idstringRequired within parentEmail template ID
Format: uuid
subjectstringRequired within parentEmail subject with ${{token}} placeholders
titlestringRequired within parentEmail template title
typeModelRequired within parentExpand Retrieve suggested ATS email templates — 200 response body — data frequently used item email template type
Template type

Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item email template type

Retrieve suggested ATS email templates — 200 response body — data frequently used item email template type
FieldTypePresenceDescription and constraints
$stringRootTemplate type
Known values: CUSTOM, DEFAULT_APPLICATION_CONFIRMATION, DEFAULT_ARCHIVE, DEFAULT_OFFER, DEFAULT_CANDIDATE_INTERVIEW_SCHEDULING, DEFAULT_QUESTIONNAIRE, DEFAULT_REFERRAL_CONFIRMATION, DEFAULT_DOCUMENT, DEFAULT_INTERVIEW_SCHEDULED_CANDIDATE, DEFAULT_INTERVIEW_SCHEDULED_INTERVIEWERS, DEFAULT_INTERVIEW_SCHEDULED_RECRUITERS, DEFAULT_INTERVIEW_RESCHEDULED_CANDIDATE, DEFAULT_INTERVIEW_RESCHEDULED_INTERVIEWERS, DEFAULT_INTERVIEW_RESCHEDULED_RECRUITERS, DEFAULT_INTERVIEW_CANCELLED_CANDIDATE, DEFAULT_INTERVIEW_CANCELLED_INTERVIEWERS, DEFAULT_INTERVIEW_CANCELLED_RECRUITERS, DEFAULT_INTERVIEWER_ADDED, DEFAULT_INTERVIEWER_REMOVED, DEFAULT_INTERVIEWERS_CHANGED_RECRUITERS, DEFAULT_INTERVIEW_RESCHEDULE_REQUEST_CANDIDATE, DEFAULT_INTERVIEW_LOCATION_UPDATED_CANDIDATE

SDK function policy ID: deel.ats_retrieveatsemailtemplatesuggestions_v2026_10_28. Catalog operation: ats_retrieveatsemailtemplatesuggestions_v2026_10_28. 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-10-28"}

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.