General
Messaging
Messaging API documentation
Introduction
These API calls relate to messaging and messaging templates
Get Message Templates
Used by subscriptions for example. All lookup values can be found under: Lookups API
| Path |
|---|
GET /messages/templates |
Success Response:
{
"status": true,
"records": [{
"id": "{unique record_id}",
"type_lookups_id": "3cda7c14-c552-4c66-b72c-1160bd5ff19f",
"name": "Invoice Notification - Payment Link",
"subject": "Invoice Notification {{date}}",
"body": "Dear {{people.name}} {{people.surname}}, To download your quote {{document_number}} for {{document_total}} click here: {{link}} Regards {{contact_name}} {{company_name}}. {{payment_link}}",
"reply_name": "no-reply",
"reply_email": "no-reply@mail.com",
"html": "<html>...</html>",
"sending_domain": "\"No-Reply\" <no-reply@mail.com>",
"sending_mobile": null,
"category_lookups_id": "4f460d54-6651-4941-aefe-1c23eb280251",
"record_type_lookups_id": "68d7ccc6-7185-4842-bb57-546d6cd6567e"
}, ...]
}
| Field | Type | Description | Options | Example |
|---|---|---|---|---|
| id | string | Unique ID associated with the message template and used in other API calls | UUID | "{unique record_id}" |
| type_lookups_id | string | Type lookups ID associated with the template | UUID | "3cda7c14-c552-4c66-b72c-1160bd5ff19f" |
| name | string | Name of the template | "Invoice Notification - Payment Link" | |
| subject | string | Subject line of the template (if applicable) | "Invoice Notification " | |
| body | string | Body of the template | "Dear , To download your quote for click here: Regards . " | |
| reply_name | string | Email reply name (if applicable) | "no-reply" | |
| reply_email | string | Reply email address (if applicable) | "no-reply@mail.com" | |
| html | string | HTML body of the template (if applicable) | "..." | |
| sending_domain | string | Email sending domain of the template (if applicable) | ""No-Reply" no-reply@mail.com" | |
| sending_mobile | string | Sending mobile number of the template (if applicable) | +27830000001 | |
| category_lookups_id | string | Category Lookups ID of the template | UUID | "4f460d54-6651-4941-aefe-1c23eb280251" |
| record_type_lookups_id | string | Record type lookups ID of the template | UUID | "68d7ccc6-7185-4842-bb57-546d6cd6567e" |