Create a template

Creates a message template. sender_id must be a sender ID your account can send from.

POST

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

Authorization

basicAuth
HTTP
required

Request body JSON required

sender_id
string
required
A sender ID your account can send from, e.g. a dedicated number in E.164 format or SHARED_NUMBER.
name
string
required
maxLength: 255
message
string
required
subject
optional
string | null
MMS subject.

maxLength: 40

Returns

201

The created 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.
- 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.
- 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

422

The request failed validation. errors lists the messages for each invalid field.

JSON

message
optional
string
errors
optional
map of
array<string>

curl --request POST \ --url https://app.touchsms.com.au/api/v2/templates \ --header 'Authorization: Basic <credentials>' \ --header 'Content-Type: application/json' \ --data ' { "sender_id": "SHARED_NUMBER", "name": "Appointment Reminder", "message": "Hi {{firstname}}, reminder of your appointment tomorrow.", "subject": "string" } '

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