social.coves.community.update

coves.social

Documentation

Update community profile. Requires authentication and moderator/admin permissions.

main procedure

Update community profile. Requires authentication and moderator/admin permissions.

Input

Encodingapplication/json
allowExternalDiscovery boolean Optional

Whether other Coves instances can index and discover this community

avatarBlob string Optional

Base64-encoded avatar image data (png, jpeg, or webp)

maxLength: 1400000 bytes
avatarMimeType string Optional

MIME type of the avatar image (image/png, image/jpeg, image/webp)

maxLength: 128 bytes
bannerBlob string Optional

Base64-encoded banner image data (png, jpeg, or webp)

maxLength: 2800000 bytes
bannerMimeType string Optional

MIME type of the banner image (image/png, image/jpeg, image/webp)

maxLength: 128 bytes
communityDid stringdid Required

DID of the community to update

contentWarnings array Optional

Required content warnings for this community

maxLength: 10 items
description string Optional

Community description

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
displayName string Optional

Display name for the community

maxLength: 1280 bytesmaxGraphemes: 128 graphemes
moderationType string Optional

Type of moderation system

maxLength: 64 bytes
visibility string Optional

Community visibility level

maxLength: 64 bytes

Output

Encodingapplication/json
cid stringcid Required

CID of the updated community profile

uri stringat-uri Required

AT-URI of the updated community profile

Errors

NotFound Community not found
NotAuthorized User is not authorized to update this community
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": [
        "communityDid"
      ],
      "properties": {
        "avatarBlob": {
          "type": "string",
          "maxLength": 1400000,
          "description": "Base64-encoded avatar image data (png, jpeg, or webp)"
        },
        "bannerBlob": {
          "type": "string",
          "maxLength": 2800000,
          "description": "Base64-encoded banner image data (png, jpeg, or webp)"
        },
        "visibility": {
          "type": "string",
          "maxLength": 64,
          "description": "Community visibility level",
          "knownValues": [
            "public",
            "unlisted",
            "private"
          ]
        },
        "description": {
          "type": "string",
          "maxLength": 10000,
          "description": "Community description",
          "maxGraphemes": 1000
        },
        "displayName": {
          "type": "string",
          "maxLength": 1280,
          "description": "Display name for the community",
          "maxGraphemes": 128
        },
        "communityDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the community to update"
        },
        "avatarMimeType": {
          "type": "string",
          "maxLength": 128,
          "description": "MIME type of the avatar image (image/png, image/jpeg, image/webp)"
        },
        "bannerMimeType": {
          "type": "string",
          "maxLength": 128,
          "description": "MIME type of the banner image (image/png, image/jpeg, image/webp)"
        },
        "moderationType": {
          "type": "string",
          "maxLength": 64,
          "description": "Type of moderation system",
          "knownValues": [
            "moderator",
            "sortition"
          ]
        },
        "contentWarnings": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 32,
            "knownValues": [
              "nsfw",
              "violence",
              "spoilers"
            ]
          },
          "maxLength": 10,
          "description": "Required content warnings for this community"
        },
        "allowExternalDiscovery": {
          "type": "boolean",
          "description": "Whether other Coves instances can index and discover this community"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "NotFound",
      "description": "Community not found"
    },
    {
      "name": "NotAuthorized",
      "description": "User is not authorized to update this community"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "CID of the updated community profile"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the updated community profile"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Update community profile. Requires authentication and moderator/admin permissions."
}

Lexicon Garden

@