place.stream.moderation.createGate Documentation (EN)

main procedure

Create a gate (hide message) on behalf of a streamer. Requires 'hide' permission. Creates a place.stream.chat.gate record in the streamer's repository.

Input

Encodingapplication/json

messageUri stringat-uri Required

The AT-URI of the chat message to hide.

streamer stringdid Required

The DID of the streamer.

Output

Encodingapplication/json

cid stringcid Required

The CID of the created gate record.

uri stringat-uri Required

The AT-URI of the created gate record.

Errors

Unauthorized The request lacks valid authentication credentials.

Forbidden The caller does not have permission to hide messages 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.

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": [
        "streamer",
        "messageUri"
      ],
      "properties": {
        "streamer": {
          "type": "string",
          "format": "did",
          "description": "The DID of the streamer."
        },
        "messageUri": {
          "type": "string",
          "format": "at-uri",
          "description": "The AT-URI of the chat message to hide."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "Unauthorized",
      "description": "The request lacks valid authentication credentials."
    },
    {
      "name": "Forbidden",
      "description": "The caller does not have permission to hide messages for this streamer."
    },
    {
      "name": "SessionNotFound",
      "description": "The streamer's OAuth session could not be found or is invalid."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "The CID of the created gate record."
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "The AT-URI of the created gate record."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": null,
  "description": "Create a gate (hide message) on behalf of a streamer. Requires 'hide' permission. Creates a place.stream.chat.gate record in the streamer's repository."
}