social.colibri.beta.community.ban

colibri.social

Documentation

Bans a member from a community. This removes their member record and stops the community issuing them space credentials. Their existing content is not deleted: it stays in their own repo, where it can still be labelled or filtered.

main procedure

Bans a member from a community. This removes their member record and stops the community issuing them space credentials. Their existing content is not deleted: it stays in their own repo, where it can still be labelled or filtered.

Input

Encodingapplication/json
community stringdid Required

The community to ban the member from.

reason string Optional

Human-readable reason for the ban.

maxLength: 512 bytes
subject stringdid Required

The member to ban.

Output

Encodingapplication/json

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
Forbidden The caller lacks the member.ban permission.
CommunityNotFound No community exists at the given DID.
AlreadyBanned The subject is already banned from this community.
RoleHierarchy The subject holds a role at or above the caller's highest role position.
CredentialsUnavailable The AppView cannot act as the community because its stored credentials are missing or unusable.
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",
        "subject"
      ],
      "properties": {
        "reason": {
          "type": "string",
          "maxLength": 512,
          "description": "Human-readable reason for the ban."
        },
        "subject": {
          "type": "string",
          "format": "did",
          "description": "The member to ban."
        },
        "community": {
          "type": "string",
          "format": "did",
          "description": "The community to ban the member from."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request is missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The caller lacks the member.ban permission."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists at the given DID."
    },
    {
      "name": "AlreadyBanned",
      "description": "The subject is already banned from this community."
    },
    {
      "name": "RoleHierarchy",
      "description": "The subject holds a role at or above the caller's highest role position."
    },
    {
      "name": "CredentialsUnavailable",
      "description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "properties": {}
    },
    "encoding": "application/json"
  },
  "description": "Bans a member from a community. This removes their member record and stops the community issuing them space credentials. Their existing content is not deleted: it stays in their own repo, where it can still be labelled or filtered."
}

Lexicon Garden

@