Skip to content

Deel: ATS email templates schemas

4 Deel schemas with complete fields and constraints.

← ATS email templates operations · All schemas

Retrieve a list of published ATS email templates — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of email templates.
data[]ModelEach itemExpand Retrieve a list of published ATS email templates — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to fetch the next page; null when there are no more pages.
next_cursor (anyOf 2)nullAlternativeCursor to fetch the next page; null when there are no more pages.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of email templates matching filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a list of published ATS email templates — 200 response body — data item

Retrieve a list of published ATS email templates — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
bodystringRequired within parentEmail body as HTML. May contain ${{token}} placeholders that are filled in when the email is sent.
created_atstringRequired within parentTimestamp of when the email template was created
Format: date-time
idstringRequired within parentEmail template unique identifier
Format: uuid
subjectstringRequired within parentEmail subject. May contain ${{token}} placeholders that are filled in when the email is sent.
titlestringRequired within parentEmail template title
typeModelRequired within parentExpand Retrieve a list of published ATS email templates — 200 response body — data item type
Template type. CUSTOM templates are written by the organization; DEFAULT_* types back built-in emails.
updated_atstringRequired within parentTimestamp of when the email template was last updated
Format: date-time

Referenced models: Retrieve a list of published ATS email templates — 200 response body — data item type

Retrieve a list of published ATS email templates — 200 response body — data item type

FieldTypePresenceDescription and constraints
$stringRootTemplate type. CUSTOM templates are written by the organization; DEFAULT_* types back built-in emails.
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

Retrieve a list of published ATS email templates — request body — query type item

FieldTypePresenceDescription and constraints
$stringRootOne of: 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

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.