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

Available in version v7+

An object that provides summary information for a message.

Properties

Name

Type

Description

Constraints

authorId

Long

The user ID of the message author.

optional

authorName

String

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

optional

externalMessageId

String

The external message ID.

optional

groupCategoryId

Long

The group category ID.

optional

groupId

Long

The group ID.

optional

id

Long

The message ID.

optional

isArchived

Boolean

Indicates whether the message is archived.

required

isSystemMessage

Boolean

Indicates whether the message was generated automatically by the system.

required

messageCategoryId

Long

The message category ID.

optional

messageName

String

The name of the message.

optional

originalMessageId

Long

The ID of the prepared message from which a message sendout was generated.

optional

sendoutDate

String

The date the message was sent. Uses Datetime type format.

optional

status

MessageStatus

The current status of the message.

optional

subjectLine

String

The message subject line.

optional

type

MessageType

The message type.

optional

  • No labels