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

String

The external message ID

optional

messageName

String

The name of the message.

optional

subjectLine

String

The message subject line.

optional

authorName

String

The name of the message author. Uses the format: lastname, firstname.

optional

authorId

Long

The user ID of the message author.

optional

messageCategoryId

Long

The message category ID.

optional

groupName

String

Name of the group assigned to the message.

optional

groupId

Long

The group ID.

optional

groupCategoryName

String

The name of the group category.

optional

groupCategoryId

Long

The group category ID.

optional

type

Message Type

The message type.

optional

status

MessageStatus

The current status of the message.

optional

sendoutDateFrom

String

Start date of time frame from which a message was sent. UsesĀ Datetime type format.

optional

sendoutDateTo

String

The end date of the time frame until which a message was sent. UsesĀ Datetime type format.

optional