---
type: api
title: Pin/unpin an event
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4641/api/doc/kibana/v8/operation/operation-persistpinnedeventroute
resource: https://www.elastic.co/elastic/docs-builder/docs/4641/api/doc/kibana/v8/operation/operation-persistpinnedeventroute
products:
  - Kibana
---

# Pin/unpin an event

Authentication: required

- Server: `https://{kibana_url}`

## Paths

- `PATCH` `/api/pinned_event`
- `PATCH` `/s/{space_id}/api/pinned_event`

#### Path parameters

- `space_id` (string) — optional
  An identifier for the space. If `space_id` is not provided in the URL, the default space is used. Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

## Description

Pin/unpin an event to/from an existing Timeline.

## Request body

The pinned event to add or unpin, along with additional metadata.

`application/json`

- `eventId` (string) — required
  The `_id` of the associated event for this pinned event.
- `pinnedEventId` (string) — optional — nullable
  The `savedObjectId` of the pinned event you want to unpin.
- `timelineId` (string) — required
  The `savedObjectId` of the timeline that you want this pinned event unpinned from.

## Response

Indicates the event was successfully pinned to or unpinned from the Timeline.

`application/json`

- `data` (object)
  - `persistPinnedEventOnTimeline` (union oneOf) — nullable
    - **PinnedEvent**
      - `created` (number) — nullable
        The time the pinned event was created, using a 13-digit Epoch timestamp.
      - `createdBy` (string) — nullable
        The user who created the pinned event.
      - `updated` (number) — nullable
        The last time the pinned event was updated, using a 13-digit Epoch timestamp
      - `updatedBy` (string) — nullable
        The user who last updated the pinned event
      - `eventId` (string)
        The `_id` of the associated event for this pinned event.
      - `timelineId` (string)
        The `savedObjectId` of the timeline that this pinned event is associated with
      - `pinnedEventId` (string)
        The `savedObjectId` of this pinned event
      - `version` (string)
        The version of this pinned event
      - `code` (number)
      - `message` (string)
    - **object**
## Code examples

#### Console

```console
PATCH kbn:/api/pinned_event
{
  "eventId": "d3a1d35a3e84a81b2f8f3859e064c224cdee1b4bc",
  "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e"
}
```

#### curl

```curl
curl -X PATCH "${KIBANA_URL}/api/pinned_event" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": "d3a1d35a3e84a81b2f8f3859e064c224cdee1b4bc",
    "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e"
  }'
```

## Response examples

#### 200

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "data": {
    "persistPinnedEventOnTimeline": {
      "created": 1587468588922,
      "createdBy": "casetester",
      "updated": 1741344876825,
      "updatedBy": "casetester",
      "eventId": "d3a1d35a3e84a81b2f8f3859e064c224cdee1b4bc",
      "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e",
      "pinnedEventId": "10r1929b-0af7-42bd-85a8-56e234f98h2f3",
      "version": "WzQ2LDFe",
      "code": 0,
      "message": "string"
    }
  }
}
```