matrix-spec-proposals/event-schemas/schema/m.room.pinned_events

---
allOf:
  - $ref: core-event-schema/state_event.yaml
description: This event is used to "pin" particular events in a room for other participants to review later. The order of the pinned events is guaranteed and based upon the order supplied in the event. Clients should be aware that the current user may not be able to see some of the events pinned due to visibility settings in the room. Clients are responsible for determining if a particular event in the pinned list is displayable, and have the option to not display it if it cannot be pinned in the client.
properties:
  content:
    properties:
      pinned:
        description: An ordered list of event IDs to pin.
        items:
          type: string
        type: array
    required:
      - pinned
    type: object
  state_key:
    description: A zero-length string.
    pattern: '^$'
    type: string
  type:
    enum:
      - m.room.pinned_events
    type: string
title: Pinned events in a room
type: object