Available in version v7+
A filter object that determines which prepared messages are included in the list of returned prepared message summary objects.
Name | Type | Description | Constraints |
---|---|---|---|
externalMessageId | The external message ID | required | |
limit | number of returned messages 1-500 | 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 | |
creationDateFrom | Start date from which a prepared message was created. Uses Datetime type | optional | |
creationDateTo | End date until which a prepared message was created. Uses Datetime type | optional | |
lastUpdateDateFrom | Start date from which a prepared message was last updated. Uses Datetime type | optional | |
lastUpdateDateTo | End date until which a prepared message was last updated. Uses Datetime type | optional |