Pin/unpin an event

PATCH /api/pinned_event
Api key auth Basic auth

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

application/json; Elastic-Api-Version=2023-10-31

Body Required

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

  • eventId string Required

    The _id of the associated event for this pinned event.

  • pinnedEventId string | null

    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.

Responses

PATCH /api/pinned_event 
curl \
 --request PATCH 'http://localhost:5622/api/pinned_event' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json; Elastic-Api-Version=2023-10-31"
Request examples 
{
  "eventId": "d3a1d35a3e84a81b2f8f3859e064c224cdee1b4bc",
  "pinnedEventId": "10r1929b-0af7-42bd-85a8-56e234f98h2f3",
  "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e"
}
Response examples (200) 
{
  "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": 42.0,
      "message": "string"
    }
  }
}