Communication ConfigurationEmail Templates

Render an email template

View as Markdown
Render an email template for the given lead/contact using the current user context. Accepts two forms of usage: - Single lead/contact: - `lead_id` and `contact_id` is supplied (both required) - Preview results from a search query - `query` (required) contains a search query - `entry` (optional, ranges from 0 to 99) specifies the index of the lead/contact that should be rendered. - `mode` (optional), which can have a value of: - `lead` (default), the first contact of the lead with the index given by `entry` will be rendered (excluding leads that have no email addresses). - `contact`, then `entry` refers to the index of the contact (excluding contacts that have no emails). Will return an empty dict if there are no more entries.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

email_account_idstringOptional
bulk_object_typeenumOptional
Allowed values:
contact_idstringOptional
contact_preferenceenumOptional
Allowed values:
entryintegerOptional0-100
lead_idstringOptional
limitintegerOptional
querystringOptional
results_limitintegerOptional
s_querystringOptional
senderstringOptionalformat: "email"
sortlist of objectsOptional
modeenumOptional
Allowed values:

Response

Successful response

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error