Available in version v7+
An object that provides summary information for a message.
Properties
Name | Type | Description | Constraints |
---|---|---|---|
authorId | The user ID of the message author. | optional | |
authorName | The name of the message author. Uses the format: lastname, firstname. | optional | |
externalMessageId | The external message ID. | optional | |
groupCategoryId | The group category ID. | optional | |
groupId | The group ID. | optional | |
id | The message ID. | optional | |
isArchived | Indicates whether the message is archived. | required | |
isSystemMessage | Indicates whether the message was generated automatically by the system. | required | |
messageCategoryId | The message category ID. | optional | |
messageName | The name of the message. | optional | |
originalMessageId | The ID of the prepared message from which a message sendout was generated. | optional | |
sendoutDate | The date the message was sent. UsesĀ Datetime type format. | optional | |
status | The current status of the message. | optional | |
subjectLine | The message subject line. | optional | |
type | The message type. | optional |