Page tree
Skip to end of metadata
Go to start of metadata

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

String

The external message ID

required

limit

Integer

number of returned messages 1-500

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

creationDateFrom

String

Start date from which a prepared message was created. Uses Datetime type

optional

creationDateTo

String

End date until which a prepared message was created. Uses Datetime type

optional

lastUpdateDateFrom

String

Start date from which a prepared message was last updated. Uses Datetime type

optional

lastUpdateDateTo

String

End date until which a prepared message was last updated. Uses Datetime type

optional

  • No labels