SmsUpdateTrigger

PUT sms/trigger

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

Disabling a trigger stops new messages from that event immediately after the next subscription refresh; messages already queued are unaffected.

Access Control

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

Request

RESTTCPSDK

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

{
  "id": 2,
  "status": "DISABLED"
}

{
  "command": "SmsUpdateTrigger",
  "extID": "1",
  "data": {
    "id": 2,
    "status": "DISABLED"
  }
}

const res = await platform.SmsUpdateTrigger({
  id: 2,
  status: "DISABLED"
});

Request Data

Field	Type	Required	Description
id	int	Yes	Trigger id
event	string	No	Bus event name
description	string	No	Free-form note
merge	object	No	Rename event fields for templates
arguments	object	No	Firing condition, { "match": { "delivery_route": "customer-recovery" } } — see Matching
type	enum	No	PRIVATE or PUBLIC
status	enum	No	ENABLED or DISABLED

Response Data

{
  "id": 2,
  "event": "crm.customer.deposit",
  "merge": { "client.msisdn": "phone", "payment.sum": "amount" },
  "type": "PRIVATE",
  "status": "DISABLED",
  "updatedAt": "2026-08-24 14:35:20"
}

Errors

Code	Error	Description
404	NOT_FOUND	Trigger not found in the brand