NewsMAN API: transactional.templateRender

Sections

Newsman – Knowledge Base

HomeAPITransactionaltransactional.templateRender

Newsman Api Method: transactional.templateRender

Prototype: transactional.templateRender(list_id, account_id)

Description: Returns a dict with the rendered HTML code in the key: content

HTTP method: GET

Endpoint HTTP: /transactional.templateRender.json

Endpoint XML-RPC: transactional.templateRender

Return type: struct

Return info: Dict with the rendered HTML code in the key: content

Request parameters GET

Variable	Type	Description
list_id	int\|string	The ID of the list from which to identify the SMTP account
account_id	string\|boolean	The id of a specific SMTP ACCOUNT from which to fetch and render the template (optional).

Response parameters

Parameter	Description
array	dict with the rendered HTML code in the key: content

Output example

{
    "content": "<html>\n    <body>\n        The start content here<br\/>\n        render_api\n    <\/body>\n<\/html>",
    "engine": "handlebars",
    "type": "html",
    "props": null
}

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
101	Not allowed for list_id = %s	Invalid access to list_id
17003	Could not find the SMTP account	Transactional account not found
17004	The SMTP account is inactive	The transactional account is inactive
17006	The template could not be fetched: [error_reason]	The template could not be fetched

Error examples

{
    "err": true,
    "message": "Missing required param list_id",
    "code": 407
}

{
    "err": true,
    "message": "Could not find the SMTP account",
    "code": 17003
}

{
    "err": true,
    "message": "The SMTP account is inactive",
    "code": 17004
}

{
    "err": true,
    "message": "The template could not be fetched: Request error No template found for template_id_2",
    "code": 17006
}