Private messages
List Private Messages
read-onlyidempotentopen-worldList authenticated personal or group private-message mailboxes. Returns normalized JSON messages and pagination metadata.
Parameters
usernamestringmailboxstringinboxsentarchiveunreadnewgroup_ namestringpageinteger>= 0per_ pageinteger[1, 100]Read Private Message
read-onlyidempotentopen-worldRead an authenticated private message, its posts, and direct allowed-user and allowed-group records. Rejects public topics.
Parameters
topic_ idintegerrequiredpost_ limitinteger[1, 50]Max posts to return (default 5, max 50)
start_ post_ numberinteger>= 1Start from this post number (1-based)
Create Private Message
Create a private message for typed user, group, or email recipients. Unknown emails may create staged users. author_username requires a global API key; the response reports actual attribution.
Parameters
titlestringrequiredrawstringrequiredusernamesArray<string>group_ namesArray<string>email_ addressesArray<string>author_ usernamestringReply to Private Message
Safely reply to an existing private message after verifying its archetype. author_username requires a global API key; the response reports actual attribution.
Parameters
topic_ idintegerrequiredrawstringrequiredreply_ to_ post_ numberintegerauthor_ usernamestringInvite to Private Message
Add a user or group to a private message, or submit an opaque email invitation. Email success does not confirm delivery or participant access. author_username requires a global API key.
Parameters
topic_ idintegerrequiredusernamestringgroup_ namestringemail_ addressstringnotify_ group_ membersbooleancustom_ messagestringauthor_ usernamestring