place.stream.chat.pinnedRecord Documentation (EN)

main record

Record pinning a chat message for prominent display.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

When this pin was created.

expiresAt string datetime Optional

Optional expiration time. If set, the pin is considered inactive after this time.

pinnedBy string did Optional

DID of the user who pinned the message.

pinnedMessage string at-uri Required

AT-URI of the pinned chat message.

View raw schema

{
  "description": "Record pinning a chat message for prominent display.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "description": "When this pin was created.",
        "format": "datetime",
        "type": "string"
      },
      "expiresAt": {
        "description": "Optional expiration time. If set, the pin is considered inactive after this time.",
        "format": "datetime",
        "type": "string"
      },
      "pinnedBy": {
        "description": "DID of the user who pinned the message.",
        "format": "did",
        "type": "string"
      },
      "pinnedMessage": {
        "description": "AT-URI of the pinned chat message.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "pinnedMessage",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}