Lexicon Garden

com.getorbyt.community.sendModmail

"Message the mods": opens the caller's private thread with the Community's mod team, or continues it. Each account has one thread per Community, and a message reopens it if the mod team archived it. Anyone signed in may write, including a muted or banned member; whoever holds manage-mail answers with replyModmail instead. Rate-limited per sender.

Repository @getorbyt.com did:plc:2xrqztnmzlckb3xfuuukupso namespace authority
Details · procedure
Kindprocedure
Authoritycommunity.getorbyt.com
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

clientId

string

The sender's own id for this message, so a send retried after a lost answer returns the message it already created rather than a second one. Opaque to the service; repeated by the same account in the same thread it names that message.

  • maxLength: 64

community

requiredstring · at-uri

text

requiredstring
  • minLength: 1
  • maxLength: 2000

Output

application/json

Errors

AuthenticationRequired

No description in schema.

CommunityNotFound

No description in schema.

InvalidRequest

No description in schema.

InvalidAction

The caller holds manage-mail, so they answer members rather than write to their own team.

RateLimitExceeded

No description in schema.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • com.getorbyt.community.replyModmail

    procedure

    Replies to a member's Modmail thread as the mod team. Requires manage-mail. Moderators cannot start a thread: they answer one a member opened. The member sees the reply in the thread and in Activity, from the team rather than from the moderator.

  • com.getorbyt.community.manageModmailThread

    procedure

    Archives a member's Modmail thread out of the open inbox, or brings it back. Requires manage-mail. A new message from the member reopens an archived thread on its own.

  • com.getorbyt.community.listModmailThreads

    query

    The mod team's Modmail inbox: one thread per member, most recent message first, each marked unread when the member wrote since this moderator last read it. Requires manage-mail. Viewer-specific and never cached.

  • com.getorbyt.community.getModmailThread

    query

    One Modmail thread and its messages, newest first. Without member, the caller's own thread, which is absent until they first write. With another account's member, the caller needs manage-mail. Viewer-specific and never cached; reading does not mark the thread read (see updateModmailSeen).

  • com.getorbyt.community.updateModmailSeen

    procedure

    Marks a Modmail thread read for the caller up to seenAt. Read state is per reader: the member's own, and each moderator's own. The mark only moves forward and never past now. Sending a message marks the thread read for its sender.