# place.stream.chat.pinnedRecord

> Published by [did:web:stream.place](https://lexicon.garden/identity/did:web:stream.place)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:web:stream.place/place.stream.chat.pinnedRecord)
- [Documentation](https://lexicon.garden/lexicon/did:web:stream.place/place.stream.chat.pinnedRecord/docs)
- [Examples](https://lexicon.garden/lexicon/did:web:stream.place/place.stream.chat.pinnedRecord/examples)

## Definitions

### `place.stream.chat.pinnedRecord`

**Type**: `record`

Record pinning a chat message for prominent display.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `pinnedBy` | `string` (did) | No | DID of the user who pinned the message. |
| `createdAt` | `string` (datetime) | Yes | When this pin was created. |
| `expiresAt` | `string` (datetime) | No | Optional expiration time. If set, the pin is considered inactive after this time. |
| `pinnedMessage` | `string` (at-uri) | Yes | AT-URI of the pinned chat message. |

## Raw Schema

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