Parameter | Type | Description | Request | Response | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | PUT | POST | DELETE | GET | PUT | POST | DELETE | |||||
accountId | String | Unique identifier of your account | Yes | Yes | Yes | |||||||
memberId | String | A unique identifier of a member | Yes | Yes | Yes | Yes | Yes | |||||
eventRefType | Enum
| Defines an even type attached to the message | Optional | Optional | Yes | Yes | Yes | |||||
eventReferenceId | String | The reference ID of the event object | Optional | Optional | Yes | Yes | Yes | |||||
messageType | Enum
| The type of message of the member | Yes | Yes | Yes | Yes | Yes | |||||
subject | String | The title of the message | Yes | Yes | Yes | Yes | Yes | |||||
body | String | The context of the message | Yes | Yes | Yes | Yes | Yes | |||||
prize | Object | Award model | Optional | Optional | Yes | Yes | Yes | |||||
status | Enum
| The status of the message | Yes | Yes | Yes | Yes | Yes | |||||
expiry | DateTime | The time that the message will disappear after. ISO8601 timestamp | Optional | Optional | Yes | Yes | Yes | |||||
created | DateTime | The time that the message was created. ISO8601 timestamp | Yes | Yes | Yes | |||||||
metadata | Array [Object] | A list of Metadata | Yes | Yes | Yes | Yes | Yes | |||||
id | String | Unique system identifier of a Member message | Yes | Yes | Yes | |||||||