social.coves.community.subscribe Documentation (EN)

main procedure

Subscribe to a community to see its posts in your feed. Requires authentication.

Input

Encodingapplication/json

community string Required

Community identifier (DID, handle, name@origin, or bare local name) of the community to subscribe to

maxLength: 320 bytes

Output

Encodingapplication/json

cid stringcid Required

CID of the created subscription record

existing boolean Optional

True if item was already subscribed

uri stringat-uri Required

AT-URI of the created subscription record

Errors

CommunityNotFound Community not found

Blocked Cannot subscribe - you are blocked from this community

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "description": "Subscribe to a community to see its posts in your feed. Requires authentication.",
  "errors": [
    {
      "description": "Community not found",
      "name": "CommunityNotFound"
    },
    {
      "description": "Cannot subscribe - you are blocked from this community",
      "name": "Blocked"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "community": {
          "description": "Community identifier (DID, handle, name@origin, or bare local name) of the community to subscribe to",
          "maxLength": 320,
          "type": "string"
        }
      },
      "required": [
        "community"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cid": {
          "description": "CID of the created subscription record",
          "format": "cid",
          "type": "string"
        },
        "existing": {
          "description": "True if item was already subscribed",
          "type": "boolean"
        },
        "uri": {
          "description": "AT-URI of the created subscription record",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "cid"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}