List templates

Returns your active message templates, plus any templates shared with your team, ordered by name. Not paginated. To send using a template, pass its message as the body of a send request; merge fields are not filled in for you.

GET

https://app.messageport.com.au/api/v2/templates

Authorization

basicAuth
HTTP
required

Returns

200

All active templates.

JSON

data
optional
array of
object
- id
  optional
  integer
- user
  optional
  integer | null
  ID of the user that owns the template. null on templates shared with your team.
- account
  optional
  integer
  Team (account) ID. Only present on templates shared with your team.
- name
  optional
  string
- message
  optional
  string
  Template body. May contain merge fields such as {{firstname}}.
- subject
  optional
  string | null
  MMS subject, up to 40 characters.
- global
  optional
  boolean
  Whether the template is shared with everyone in your team.
- replies
  optional
  boolean
  Whether replies are enabled for messages sent with this template.
- sender_id
  optional
  string | null
  Sender ID the template sends from.
- updated
  optional
  string
  format: date-time
- created
  optional
  string
  format: date-time
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

{ "data": [ { "id": 1234, "user": 5678, "name": "Appointment Reminder", "message": "Hi {{firstname}}, reminder of your appointment tomorrow.", "subject": null, "replies": true, "sender_id": "SHARED_NUMBER", "updated": "2024-03-11T02:14:07Z", "created": "2024-02-02T23:51:19Z" } ] }