social.colibri.beta.role.delete Documentation (EN)

main procedure

Deletes a role.

Input

Encodingapplication/json

community stringdid Required

The community the role belongs to.

role stringrecord-key Required

The role's record key.

Output

Encodingapplication/json

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.

Forbidden The caller lacks the role.manage permission.

CommunityNotFound No community exists at the given DID.

RoleNotFound No role exists at the given record key.

RoleProtected The role is marked protected and cannot be deleted.

RoleHierarchy The role is 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.

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

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "community",
        "role"
      ],
      "properties": {
        "role": {
          "type": "string",
          "format": "record-key",
          "description": "The role's record key."
        },
        "community": {
          "type": "string",
          "format": "did",
          "description": "The community the role belongs to."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request is missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The caller lacks the role.manage permission."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists at the given DID."
    },
    {
      "name": "RoleNotFound",
      "description": "No role exists at the given record key."
    },
    {
      "name": "RoleProtected",
      "description": "The role is marked protected and cannot be deleted."
    },
    {
      "name": "RoleHierarchy",
      "description": "The role is 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": "Deletes a role."
}