social.colibri.role.create Documentation (EN)

main procedure

Creates a role in a community.

Parameters

color string Optional

No description available.

community stringat-uri Required

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

hoisted boolean Optional

No description available.

mentionable boolean Optional

No description available.

name string Required

No description available.

permissions array Required

No description available.

position integer Required

No description available.

Output

Encodingapplication/json

uri stringat-uri Required

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

Errors

AppViewNotAuthorized The acting account has not published this AppView as authorized to act for it.

AuthRequired Missing, malformed, or unverifiable service auth.

CommunityCredentialsUnrecoverable The AppView cannot write to the community's repo and could not repair its own access.

Forbidden The caller lacks the permission this method requires.

InvalidRequest A parameter or body field was missing or malformed.

NotCommunityHub This AppView does not administer the community; the hub field names the one that does.

PdsUnavailable The PDS this operation needs is unreachable or is not a PDS.

UpstreamFailure A service outside this AppView failed.

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)

View raw schema

{
  "type": "procedure",
  "errors": [
    {
      "name": "AppViewNotAuthorized",
      "description": "The acting account has not published this AppView as authorized to act for it."
    },
    {
      "name": "AuthRequired",
      "description": "Missing, malformed, or unverifiable service auth."
    },
    {
      "name": "CommunityCredentialsUnrecoverable",
      "description": "The AppView cannot write to the community's repo and could not repair its own access."
    },
    {
      "name": "Forbidden",
      "description": "The caller lacks the permission this method requires."
    },
    {
      "name": "InvalidRequest",
      "description": "A parameter or body field was missing or malformed."
    },
    {
      "name": "NotCommunityHub",
      "description": "This AppView does not administer the community; the hub field names the one that does."
    },
    {
      "name": "PdsUnavailable",
      "description": "The PDS this operation needs is unreachable or is not a PDS."
    },
    {
      "name": "UpstreamFailure",
      "description": "A service outside this AppView failed."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community",
      "name",
      "permissions",
      "position"
    ],
    "properties": {
      "name": {
        "type": "string"
      },
      "color": {
        "type": "string"
      },
      "hoisted": {
        "type": "boolean"
      },
      "position": {
        "type": "integer"
      },
      "community": {
        "type": "string",
        "format": "at-uri"
      },
      "mentionable": {
        "type": "boolean"
      },
      "permissions": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "description": "Creates a role in a community."
}