place.stream.moderation.createPin Documentation (EN)

main procedure

Pin a chat message on behalf of a streamer. Requires 'message.pin' permission. Creates a place.stream.chat.pinnedRecord in the streamer's repo, replacing any existing pin.

Input

Encodingapplication/json

expiresAt stringdatetime Optional

Optional expiration time for this pin.

messageUri stringat-uri Required

The AT-URI of the chat message to pin.

streamer stringdid Required

The DID of the streamer.

Output

Encodingapplication/json

cid stringcid Required

The CID of the created pinned record.

uri stringat-uri Required

The AT-URI of the created pinned record.

Errors

Unauthorized The request lacks valid authentication credentials.

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

{
  "description": "Pin a chat message on behalf of a streamer. Requires 'message.pin' permission. Creates a place.stream.chat.pinnedRecord in the streamer's repo, replacing any existing pin.",
  "errors": [
    {
      "description": "The request lacks valid authentication credentials.",
      "name": "Unauthorized"
    },
    {
      "description": "The caller does not have permission to pin messages 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": {
        "expiresAt": {
          "description": "Optional expiration time for this pin.",
          "format": "datetime",
          "type": "string"
        },
        "messageUri": {
          "description": "The AT-URI of the chat message to pin.",
          "format": "at-uri",
          "type": "string"
        },
        "streamer": {
          "description": "The DID of the streamer.",
          "format": "did",
          "type": "string"
        }
      },
      "required": [
        "streamer",
        "messageUri"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cid": {
          "description": "The CID of the created pinned record.",
          "format": "cid",
          "type": "string"
        },
        "uri": {
          "description": "The AT-URI of the created pinned record.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "cid"
      ],
      "type": "object"
    }
  },
  "parameters": null,
  "type": "procedure"
}