Get a rendered preview of an email template for a contact.

Required permissions: Create and edit email templates

get

Path parameters

templateIDstring · uuidRequired

referenceIDstring · uuidRequired

Query parameters

apiTokenstringRequired

API authentication token

Responses

200

OK

application/json

referenceIDstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

tostringOptional

fromstringOptional

replystringOptional

subjectstringOptional

textstringOptional

htmlstringOptional

400

Missing Parameter Value

application/json

401

Incorrect Permissions or Invalid API Token

application/json

500

Engage Server Error. Unable to process response at this time.

application/json

get/mail/templates/preview/{templateID}/{referenceID}

GET /mail/templates/preview/{templateID}/{referenceID}?apiToken=text HTTP/1.1
Host: api.ubiquity.co.nz
Accept: */*

{
  "referenceID": "00000000-0000-0000-0000-000000000000",
  "to": "text",
  "from": "text",
  "reply": "text",
  "subject": "text",
  "text": "text",
  "html": "text"
}