Parameter | Type | Description | Request | Response | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | PUT | POST | DELETE | GET | PUT | POST | DELETE | |||||
accountId | String | Unique identifier of your account | Yes | Yes | Yes | |||||||
userId | String | A unique identifier of a user | Yes | Yes | Yes | Yes | Yes | |||||
eventRefType | Enum
| Defines an even type attached to the message | Optional | Optional | Yes | Yes | Yes | |||||
eventRefId | String | The reference ID of the event object | Optional | Optional | Yes | Yes | Yes | |||||
messageType | Enum
| The type of message of the account | Yes | Yes | Yes | Yes | Yes | |||||
subject | String | A label or a subject of a message | Yes | Yes | Yes | Yes | Yes | |||||
body | String | The input information about the subject | Yes | Yes | Yes | Yes | Yes | |||||
status | Enum
| The status of the message of the account | Yes | Yes | Yes | Yes | Yes | |||||
expiry | DateTime | The time when the message will disappear | Optional | Optional | Yes | Yes | Yes | |||||
metadata | Array [Object] | A list of MetaData | Yes | Yes | Yes | Yes | Yes | |||||
created | DateTime | ISO8601 timestamp for when an Account message was created. All records are stored in UTC time zone. | Yes | Yes | Yes | |||||||
id | String | Unique system identifier of an Account message | Yes | Yes | Yes |