Render an email template

GET

https://api.close.com/api/v1/email_template/:id/render/

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.

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

Use your API key as the username and leave the password empty.

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

1	{
2	"body": "Hi John,\n\nI hope you are having a great day.\n\nFrom,\nPhil\nphil@close.com",
3	"contact_display_name": "John Smith",
4	"contact_id": "cont_NdKMSOuamgB8ZlbNJW2WP17hfL3jQmf0hW6X8ichwQk",
5	"email": "john@example.com",
6	"lead_display_name": "Bluth Company",
7	"lead_id": "lead_vYaUG0D39KdBeqVHbPkmvqaYopsdCBmDXW3tvJgwc2L",
8	"subject": "Checking In"
9	}

1	{
2	"body": "Hi John,\n\nI hope you are having a great day.\n\nFrom,\nPhil\nphil@close.com",
3	"contact_display_name": "John Smith",
4	"contact_id": "cont_NdKMSOuamgB8ZlbNJW2WP17hfL3jQmf0hW6X8ichwQk",
5	"email": "john@example.com",
6	"lead_display_name": "Bluth Company",
7	"lead_id": "lead_vYaUG0D39KdBeqVHbPkmvqaYopsdCBmDXW3tvJgwc2L",
8	"subject": "Checking In"
9	}

$	curl https://api.close.com/api/v1/email_template/id/render/ \
>	-u "<CLOSE_API_KEY>:"