place.stream.moderation.createBlock

moderation.stream.place View official

Documentation

Create a block (ban) on behalf of a streamer. Requires 'ban' permission. Creates an app.bsky.graph.block record in the streamer's repository.

main procedure

Create a block (ban) on behalf of a streamer. Requires 'ban' permission. Creates an app.bsky.graph.block record in the streamer's repository.

Input

Encodingapplication/json
reason string Optional

Optional reason for the block.

maxLength: 300 bytes
streamer stringdid Required

The DID of the streamer whose chat this block applies to.

subject stringdid Required

The DID of the user being blocked from chat.

Output

Encodingapplication/json
cid stringcid Required

The CID of the created block record.

uri stringat-uri Required

The AT-URI of the created block record.

Errors

Unauthorized The request lacks valid authentication credentials.
Forbidden The caller does not have permission to create blocks for this streamer.
SessionNotFound The streamer's OAuth session could not be found or is invalid.
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": "Create a block (ban) on behalf of a streamer. Requires 'ban' permission. Creates an app.bsky.graph.block record in the streamer's repository.",
  "errors": [
    {
      "description": "The request lacks valid authentication credentials.",
      "name": "Unauthorized"
    },
    {
      "description": "The caller does not have permission to create blocks for this streamer.",
      "name": "Forbidden"
    },
    {
      "description": "The streamer's OAuth session could not be found or is invalid.",
      "name": "SessionNotFound"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "reason": {
          "description": "Optional reason for the block.",
          "maxLength": 300,
          "type": "string"
        },
        "streamer": {
          "description": "The DID of the streamer whose chat this block applies to.",
          "format": "did",
          "type": "string"
        },
        "subject": {
          "description": "The DID of the user being blocked from chat.",
          "format": "did",
          "type": "string"
        }
      },
      "required": [
        "streamer",
        "subject"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cid": {
          "description": "The CID of the created block record.",
          "format": "cid",
          "type": "string"
        },
        "uri": {
          "description": "The AT-URI of the created block record.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "cid"
      ],
      "type": "object"
    }
  },
  "parameters": null,
  "type": "procedure"
}

Lexicon Garden

@