Get a template

Returns one of your templates, or a template shared with your team.

GET

https://app.messageport.com.au/api/v2/templates/{template}

Authorization

basicAuth
HTTP
required

Path parameters

template
integer
required
Template ID.

Returns

200

The template.

JSON

data
optional
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

403

The resource exists but does not belong to you, or you lack permission.

JSON

message
string
required

404

The resource does not exist.

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" } }