Update message by ID

put https://api.kustomerapp.com/v1/messages/{id}

Updates a message based on the unique message ID.

Any one of the following roles is required for this endpoint:

Legacy Role	Equivalent Permission Set Role
org.user.message.write	org.permission.message.update

Note

This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single message. To learn more, see Rate limiting.

Authorization

The org.admin role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy. Otherwise, these attributes are automatically set by the token.

Custom Attributes

Custom attributes are optional and allow you to specify custom key-value pairs.

Kustomer uses a naming convention for custom attributes to specify the field data type with a name suffix:

Naming Suffix

Num number or null
At date-time or null
Str string or null, length: [ 0 .. 1024 ] characters
Txt string or null, length: [ 0 .. 1024 ] characters
Bool boolean or null
Url string or null, format: uri