social.colibri.beta.community.update

colibri.social

Documentation

Updates a community's settings. A field left absent stays unchanged.

main procedure

Updates a community's settings. A field left absent stays unchanged.

Input

Encodingapplication/json
community stringdid Required

The community to update.

description string Optional

The community's description.

maxLength: 256 bytes
labelers array Optional

DIDs whose labels this community honours.

linkEmbeds boolean Optional

Whether link previews are shown by default.

name string Optional

The community's name.

maxLength: 32 bytesminLength: 1 bytes
requiresApprovalToJoin boolean Optional

Whether joining produces an application to approve.

Output

Encodingapplication/json

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
Forbidden The requesting user lacks the community.manage permission.
CommunityNotFound No community exists with that DID.
CredentialsUnavailable The AppView's stored credentials for this community are missing or unusable.
UpstreamFailure A PDS or third-party call the AppView depends on failed.
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 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "community"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 32,
          "minLength": 1,
          "description": "The community's name."
        },
        "labelers": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "did",
            "description": "A labeler."
          },
          "description": "DIDs whose labels this community honours."
        },
        "community": {
          "type": "string",
          "format": "did",
          "description": "The community to update."
        },
        "linkEmbeds": {
          "type": "boolean",
          "description": "Whether link previews are shown by default."
        },
        "description": {
          "type": "string",
          "maxLength": 256,
          "description": "The community's description."
        },
        "requiresApprovalToJoin": {
          "type": "boolean",
          "description": "Whether joining produces an application to approve."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request is missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The requesting user lacks the community.manage permission."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists with that DID."
    },
    {
      "name": "CredentialsUnavailable",
      "description": "The AppView's stored credentials for this community are missing or unusable."
    },
    {
      "name": "UpstreamFailure",
      "description": "A PDS or third-party call the AppView depends on failed."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "community"
      ],
      "properties": {
        "community": {
          "ref": "social.colibri.beta.community.defs#communityView",
          "type": "ref",
          "description": "The updated community."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Updates a community's settings. A field left absent stays unchanged."
}

Lexicon Garden

@