com.getorbyt.community.setAnnouncement

getorbyt.com

Documentation

Sets or clears the Community's announcement, shown on its page and, when set or changed, in its members' activity as `communityAnnouncement`. Requires manage-settings. The announcement is service state rather than part of the declaration record, so a moderator granted manage-settings can set it without writing the owner's repository. Setting and clearing are both recorded in the moderation log.

main procedure

Sets or clears the Community's announcement, shown on its page and, when set or changed, in its members' activity as `communityAnnouncement`. Requires manage-settings. The announcement is service state rather than part of the declaration record, so a moderator granted manage-settings can set it without writing the owner's repository. Setting and clearing are both recorded in the moderation log.

Input

Encodingapplication/json
community stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

text string Optional

The announcement text. Absent or blank clears the announcement.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

Output

Encodingapplication/json
changed boolean Required

No description available.

Errors

AuthenticationRequired
CommunityNotFound
InsufficientRole
InvalidRequest
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Sets or clears the Community's announcement, shown on its page and, when set or changed, in its members' activity as `communityAnnouncement`. Requires manage-settings. The announcement is service state rather than part of the declaration record, so a moderator granted manage-settings can set it without writing the owner's repository. Setting and clearing are both recorded in the moderation log.",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "CommunityNotFound"
    },
    {
      "name": "InsufficientRole"
    },
    {
      "name": "InvalidRequest"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "community": {
          "format": "at-uri",
          "type": "string"
        },
        "text": {
          "description": "The announcement text. Absent or blank clears the announcement.",
          "maxGraphemes": 300,
          "maxLength": 3000,
          "type": "string"
        }
      },
      "required": [
        "community"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "announcement": {
          "description": "The announcement now. Absent once cleared.",
          "ref": "com.getorbyt.community.defs#announcementView",
          "type": "ref"
        },
        "changed": {
          "type": "boolean"
        }
      },
      "required": [
        "changed"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@