com.getorbyt.community.deleteRole

getorbyt.com

Documentation

Deletes a role the Community defined, or, for the key moderator, puts the built-in moderator role back to its default permissions. A role someone holds cannot be deleted; move them to another role first. Only an administrator may delete roles. Recorded in the moderation log.

main procedure

Deletes a role the Community defined, or, for the key moderator, puts the built-in moderator role back to its default permissions. A role someone holds cannot be deleted; move them to another role first. Only an administrator may delete roles. Recorded in the moderation log.

Input

Encodingapplication/json
community stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

key string Required

No description available.

maxLength: 64 bytes

Output

Encodingapplication/json
deleted boolean Required

No description available.

Errors

AuthenticationRequired
CommunityNotFound
InsufficientRole
InvalidRequest
RoleNotFound
RoleInUse A member holds this role. Move them to another role first.
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
{
  "description": "Deletes a role the Community defined, or, for the key moderator, puts the built-in moderator role back to its default permissions. A role someone holds cannot be deleted; move them to another role first. Only an administrator may delete roles. Recorded in the moderation log.",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "CommunityNotFound"
    },
    {
      "name": "InsufficientRole"
    },
    {
      "name": "InvalidRequest"
    },
    {
      "name": "RoleNotFound"
    },
    {
      "description": "A member holds this role. Move them to another role first.",
      "name": "RoleInUse"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "community": {
          "format": "at-uri",
          "type": "string"
        },
        "key": {
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "community",
        "key"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "deleted": {
          "type": "boolean"
        }
      },
      "required": [
        "deleted"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@