social.colibri.beta.channel.reorder

colibri.social

Documentation

Sets the channel order within one category.

main procedure

Sets the channel order within one category.

Input

Encodingapplication/json
category stringrecord-key Required

The category to reorder.

channels array Required

The complete new order for the category's channels, by channel space key.

community stringdid Required

The community the category belongs to.

Output

Encodingapplication/json

Errors

AuthRequired The request has no valid service auth.
Forbidden The requesting user lacks the channel.update permission.
CommunityNotFound No community matches the given DID.
CategoryNotFound No category matches the given record key.
InvalidRequest The given channels do not match the category's current set of channels.
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 
{
  "description": "Sets the channel order within one category.",
  "errors": [
    {
      "description": "The request has no valid service auth.",
      "name": "AuthRequired"
    },
    {
      "description": "The requesting user lacks the channel.update permission.",
      "name": "Forbidden"
    },
    {
      "description": "No community matches the given DID.",
      "name": "CommunityNotFound"
    },
    {
      "description": "No category matches the given record key.",
      "name": "CategoryNotFound"
    },
    {
      "description": "The given channels do not match the category's current set of channels.",
      "name": "InvalidRequest"
    },
    {
      "description": "The AppView cannot act as the community because its stored credentials are missing or unusable.",
      "name": "CredentialsUnavailable"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "category": {
          "description": "The category to reorder.",
          "format": "record-key",
          "type": "string"
        },
        "channels": {
          "description": "The complete new order for the category's channels, by channel space key.",
          "items": {
            "description": "A channel's space key.",
            "format": "record-key",
            "type": "string"
          },
          "type": "array"
        },
        "community": {
          "description": "The community the category belongs to.",
          "format": "did",
          "type": "string"
        }
      },
      "required": [
        "community",
        "category",
        "channels"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {},
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@