MailerUpdateTrigger

PUT mailer/trigger

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

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

Access Control

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

Request

RESTTCPSDK

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

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

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

const res = await platform.MailerUpdateTrigger({
  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	Extra static values passed to templates
type	enum	No	PRIVATE or PUBLIC
status	enum	No	ENABLED or DISABLED

Response Data

{
  "id": 2,
  "event": "crm.customer.deposit",
  "merge": { "client.email": "email", "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