Available in version v7+
A filter object that determines which messages are included in the list of returned message summary objects.
Name | Type | Description | Constraints |
---|---|---|---|
externalMessageId | The external message ID | optional | |
messageName | The name of the message. | optional | |
subjectLine | The message subject line. | optional | |
authorName | The name of the message author. Uses the format: lastname, firstname. | optional | |
authorId | The user ID of the message author. | optional | |
messageCategoryId | The message category ID. | optional | |
groupName | Name of the group assigned to the message. | optional | |
groupId | The group ID. | optional | |
groupCategoryName | The name of the group category. | optional | |
groupCategoryId | The group category ID. | optional | |
type | The message type. | optional | |
status | The current status of the message. | optional | |
sendoutDateFrom | Start date of time frame from which a message was sent. UsesĀ Datetime type format. | optional | |
sendoutDateTo | The end date of the time frame until which a message was sent. UsesĀ Datetime type format. | optional |