On by default

Private messages

List Private Messages

read-onlyidempotentopen-world
discourse_list_private_messages

List authenticated personal or group private-message mailboxes. Returns normalized JSON messages and pagination metadata.

Parameters

usernamestring
mailboxstringinboxsentarchiveunreadnew
group_namestring
pageinteger>= 0
per_pageinteger[1, 100]

Read Private Message

read-onlyidempotentopen-world
discourse_read_private_message

Read an authenticated private message, its posts, and direct allowed-user and allowed-group records. Rejects public topics.

Parameters

topic_idintegerrequired
post_limitinteger[1, 50]

Max posts to return (default 5, max 50)

start_post_numberinteger>= 1

Start from this post number (1-based)

Create Private Message

discourse_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

titlestringrequired
rawstringrequired
usernamesArray<string>
group_namesArray<string>
email_addressesArray<string>
author_usernamestring

Reply to Private Message

discourse_reply_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_idintegerrequired
rawstringrequired
reply_to_post_numberinteger
author_usernamestring

Invite to Private Message

discourse_invite_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_idintegerrequired
usernamestring
group_namestring
email_addressstring
notify_group_membersboolean
custom_messagestring
author_usernamestring