Parameter

Type

Description














Request













Response
GETPUTPOSTDELETEGETPUTPOSTDELETE
accountId
StringUnique identifier of your account



Yes
YesYes
userId

String

A unique identifier of a user


YesYes
YesYesYes
eventRefType

Enum

  • Competition
  • Contest
  • Achievement
  • UserType
  • MemberNotification
Defines an even type attached to the message
OptionalOptional
YesYesYes
eventRefId
StringThe reference ID of the event object
OptionalOptional
YesYesYes
messageType

Enum

  • Notification
  • Inbox-Item
  • Notification-Inbox-Item
The type of message of the account
YesYes
YesYesYes
subject
StringA label or a subject of a message
YesYes
YesYesYes
body
String

The input information about the subject


YesYes
YesYesYes
status

Enum

  • New
  • Read
  • CollaborationRequest

  • Actioned
  • Claimed
  • Expired
  • Canceled
  • Deprecated
The status of the message of the account
YesYes
YesYesYes
expiry
DateTimeThe time when the message will disappear
OptionalOptional
YesYesYes
metadata
Array [Object]A list of MetaData
YesYes
YesYesYes
created
DateTimeISO8601 timestamp for when an Account message was created. All records are stored in UTC time zone.



YesYesYes
id
StringUnique system identifier of an Account message



YesYesYes