social.colibri.beta.community.adopt

colibri.social

Documentation

Adopts an existing account as a community: this AppView takes custody of its credentials, creates the four community spaces on whichever PDS already hosts it, and seeds the same starter layout social.colibri.beta.community.create does. The account keeps its own DID, handle and PDS, and the caller becomes its owner. Use this instead of community.create to bring your own DID.

main procedure

Adopts an existing account as a community: this AppView takes custody of its credentials, creates the four community spaces on whichever PDS already hosts it, and seeds the same starter layout social.colibri.beta.community.create does. The account keeps its own DID, handle and PDS, and the caller becomes its owner. Use this instead of community.create to bring your own DID.

Input

Encodingapplication/json
description string Optional

The community's description.

maxLength: 256 bytes
did stringdid Required

The account to adopt. The credentials must authenticate as this exact DID, which is what proves the caller controls it.

identifier string Required

The identifier used to authenticate with the account's PDS, such as its handle or DID.

name string Required

The community's name.

maxLength: 32 bytesminLength: 1 bytes
password string Required

The account's password. An app password is not enough: minting a delegation token requires full access.

Output

Encodingapplication/json

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
InvalidRequest The arguments are inconsistent or malformed beyond schema validation.
AlreadyExists This account is already a community on this AppView.
CredentialsRejected The PDS refused the given identifier and password.
IdentityMismatch The credentials authenticate a different account than the DID given.
SpacesUnsupported The account's PDS does not implement com.atproto.simplespace, so it cannot host community spaces.
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": [
        "did",
        "identifier",
        "password",
        "name"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "The account to adopt. The credentials must authenticate as this exact DID, which is what proves the caller controls it."
        },
        "name": {
          "type": "string",
          "maxLength": 32,
          "minLength": 1,
          "description": "The community's name."
        },
        "password": {
          "type": "string",
          "description": "The account's password. An app password is not enough: minting a delegation token requires full access."
        },
        "identifier": {
          "type": "string",
          "description": "The identifier used to authenticate with the account's PDS, such as its handle or DID."
        },
        "description": {
          "type": "string",
          "maxLength": 256,
          "description": "The community's description."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request is missing, malformed, or unverifiable service auth."
    },
    {
      "name": "InvalidRequest",
      "description": "The arguments are inconsistent or malformed beyond schema validation."
    },
    {
      "name": "AlreadyExists",
      "description": "This account is already a community on this AppView."
    },
    {
      "name": "CredentialsRejected",
      "description": "The PDS refused the given identifier and password."
    },
    {
      "name": "IdentityMismatch",
      "description": "The credentials authenticate a different account than the DID given."
    },
    {
      "name": "SpacesUnsupported",
      "description": "The account's PDS does not implement com.atproto.simplespace, so it cannot host community spaces."
    },
    {
      "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 adopted community."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Adopts an existing account as a community: this AppView takes custody of its credentials, creates the four community spaces on whichever PDS already hosts it, and seeds the same starter layout social.colibri.beta.community.create does. The account keeps its own DID, handle and PDS, and the caller becomes its owner. Use this instead of community.create to bring your own DID."
}

Lexicon Garden

@