social.colibri.community.update

colibri.social

Documentation

Updates a community's metadata and optionally its picture and banner.

main procedure

Updates a community's metadata and optionally its picture and banner.

Parameters

community stringat-uri Required

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

description string Optional

No description available.

linkEmbeds boolean Optional

No description available.

name string Optional

No description available.

removeBanner boolean Optional

Drops the community's current banner. Cannot be combined with a new banner blob.

removePicture boolean Optional

Drops the community's current picture. Cannot be combined with a new picture blob.

requiresApprovalToJoin boolean Optional

No description available.

Input

Encodingmultipart/form-data

Accepts raw binary data

Output

Encodingapplication/json
uri stringat-uri Required

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

Errors

AppViewNotAuthorized The acting account has not published this AppView as authorized to act for it.
AuthRequired Missing, malformed, or unverifiable service auth.
CommunityCredentialsUnrecoverable The AppView cannot write to the community's repo and could not repair its own access.
Forbidden The caller lacks the permission this method requires.
InvalidRequest A parameter or body field was missing or malformed.
NotCommunityHub This AppView does not administer the community; the hub field names the one that does.
PdsUnavailable The PDS this operation needs is unreachable or is not a PDS.
UpstreamFailure A service outside this AppView 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": {
    "encoding": "multipart/form-data",
    "description": "Optional replacement community image blobs, as `picture` and `banner` parts."
  },
  "errors": [
    {
      "name": "AppViewNotAuthorized",
      "description": "The acting account has not published this AppView as authorized to act for it."
    },
    {
      "name": "AuthRequired",
      "description": "Missing, malformed, or unverifiable service auth."
    },
    {
      "name": "CommunityCredentialsUnrecoverable",
      "description": "The AppView cannot write to the community's repo and could not repair its own access."
    },
    {
      "name": "Forbidden",
      "description": "The caller lacks the permission this method requires."
    },
    {
      "name": "InvalidRequest",
      "description": "A parameter or body field was missing or malformed."
    },
    {
      "name": "NotCommunityHub",
      "description": "This AppView does not administer the community; the hub field names the one that does."
    },
    {
      "name": "PdsUnavailable",
      "description": "The PDS this operation needs is unreachable or is not a PDS."
    },
    {
      "name": "UpstreamFailure",
      "description": "A service outside this AppView failed."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community"
    ],
    "properties": {
      "name": {
        "type": "string"
      },
      "community": {
        "type": "string",
        "format": "at-uri"
      },
      "linkEmbeds": {
        "type": "boolean"
      },
      "description": {
        "type": "string"
      },
      "removeBanner": {
        "type": "boolean",
        "description": "Drops the community's current banner. Cannot be combined with a new banner blob."
      },
      "removePicture": {
        "type": "boolean",
        "description": "Drops the community's current picture. Cannot be combined with a new picture blob."
      },
      "requiresApprovalToJoin": {
        "type": "boolean"
      }
    }
  },
  "description": "Updates a community's metadata and optionally its picture and banner."
}

Lexicon Garden

@