NewsMAN API: template.mailTemplateGet

Sections

KB Newsman

HomeAPITemplatetemplate.mailTemplateGet

Newsman Api Method: template.mailTemplateGet

Prototype: template.mailTemplateGet(template_id)

Description: Returns the content of this template as hash array for this $template_id

HTTP method: GET

Endpoint HTTP: /template.mailTemplateGet.json

Endpoint XML-RPC: template.mailTemplateGet

Return type: struct

Return info: Hash array with keys: list_id, type, subject, text, html

Request parameters GET

Variable	Type	Description
template_id	string\|int	The ID of the template for which to get the content

Response parameters

Parameter	Description
list_id	The List ID of the template
type	The type of the template
subject	The subject of the template
text	The text of the template
html	The html of the template

Output example

{
    "list_id": "my_list_id",
    "type": "subscribe_confirm",
    "subject": "Test Subject",
    "text": "Please confirm your subscription [##confirm_link##]",
    "html": "<html><body><a href=\"##confirm_link##\">Please confirm your subscription<\/a><\/body><\/html>"
}

Response Errors

Code	Message	Description
407	Missing required param template_id	template_id param is required
203	Could not get the email template	Template not found

Error examples

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

{
    "err": true,
    "message": "Could not get the email template",
    "code": 203
}