SmsUpdateTemplate¶

PUT sms/template

Updates a template. Only the fields present in the request are changed.

Editing the text changes what the next message will say; messages already queued keep the text they were rendered with, because that is what the recipient will actually read.

Access Control¶

Allowed role: admin, within the brand of the caller.

Request¶

RESTTCPSDK

PUT https://{broker_domain}/sms/template

{
  "id": 4,
  "text": "{{name}}, we received your deposit of {{amount}}"
}

{
  "command": "SmsUpdateTemplate",
  "extID": "1",
  "data": {
    "id": 4,
    "text": "{{name}}, we received your deposit of {{amount}}"
  }
}

const res = await platform.SmsUpdateTemplate({
  id: 4,
  text: "{{name}}, we received your deposit of {{amount}}"
});

Request Data¶

Field	Type	Required	Description
`id`	int	Yes	Template id
`name`	string	No	Template name
`description`	string	No	Free-form note
`text`	string	No	Message text with placeholders
`language`	string	No	Language code
`triggerId`	int	No	Trigger that fires this template
`profileId`	int	No	Restrict to one provider profile
`kind`	enum	No	`TRANSACTIONAL` or `MARKETING`
`status`	enum	No	`ENABLED` or `DISABLED`

Response Data¶

{
  "id": 4,
  "name": "Deposit confirmed",
  "text": "{{name}}, we received your deposit of {{amount}}",
  "language": "EN",
  "kind": "TRANSACTIONAL",
  "triggerId": 2,
  "status": "ENABLED",
  "updatedAt": "2026-08-24 14:31:07"
}

Errors¶

Code	Error	Description
`400`	`VALIDATION_ERROR`	Text longer than 2000 characters
`404`	`NOT_FOUND`	Template, trigger, or profile not found in the brand