System Messages and custom Messages are used for sending Users notifications. For example, a Message may be sent by email when someone has been invited to collaborate on an entity.
{
"brandCode": "{brandCode}",
"name": "sdCreationEmailNotification",
"displayName": "string",
"description": "string",
"templateTitle": "Your new sponsored SideDrawer!",
"templateBody": "<html>Some text</html>",
"locale": "en-CA",
"enabled": true,
"notificationMethod": "push",
"customSenderName": "string"
}
Message entity
brandCode string required
Branding code.
name string required
The normalized display name.
displayName string required
Name.
description string required
Description.
templateTitle string required
Template title.
templateBody string required
Template body.
locale enum required
Locale. Possible values: en-CA, fr-CA, en-US, es-US.
enabled boolean required
True if the Message is enabled.
notificationMethod enum required
Notification method. Possible values: push, email, sms, log.
customSenderName string required
Use a custom sender name for the Message.