NewsMAN API: transactional.templateGet

Sections

Newsman – Knowledge Base

HomeAPITransactionaltransactional.templateGet

Newsman Api Method: transactional.templateGet

Prototype: transactional.templateGet(list_id, template_id, account_id)

Description: Returns a dict containing the template data: type, content

HTTP method: GET

Endpoint HTTP: /transactional.templateGet.json

Endpoint XML-RPC: transactional.templateGet

Return type: struct

Return info: Dict containing the template data: type, content

Request parameters GET

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

Response parameters

Parameter	Description
array	dict containing the template data: type, content

Output example

{
    "content": "<html>\n    <body>\n        The start content here<br\/>\n        s\n    {{specific_id}}<\/body>\n<\/html>",
    "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
}