Field | Visibility | Type | Description |
id | public | int | |
topic_id | public | int | When a new message (not a reply) is first sent, it's assigned a topic_id. All future responses to that message will have the same topic_id. Within the Members Area > Messages section, this servers to thread messages together. |
topic_type | public | string | |
topic_title | public | string | The title of the first message with the same topic_id (ie: the original message in the thread). |
title | public | string | The title of this message. |
content | public | string | The content (body) of this message. |
sender_username | public | username | |
receiver_username | public | username | |
flag_read | public | bool | If the message had been read by the receiver by opening it online. Note that accessing messages through the API does not mark messages as read. |
created_at | public | time |
Name | Required | Type | Notes |
id | Y | int | The id of the Message to retrieve. |
Name | Required | Type | Notes |
id | Y | int | The id of the Message you want to reply to. |
title | N | int | The title of your reply message. |
content | Y | int | The content (body) of your reply message. |
Name | Required | Type | Notes |
id | Y | int | The id of the Message you want to archive. |
Name | Required | Type | Notes |
limit | N | int | Default: 25 |
page | N | int | Default: 1 |
filter | N | enum (received, sent) | Default: received |
unread | N | bool | |
archived | N | bool | Default: 0 |
keywords | N | string | Limit the results to messages which contain these keywords in the title or content, or where the sender or receiver's username is an exact match to the keywords string. |