Sign in

v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-076771,7565.2 MB
Security Timeline API

Pin/unpin an event

Spaces method and path for this operation:

<div><span class="operation-verb patch">patch</span>&nbsp;<span class="operation-path">/s/{space_id}/api/pinned_event</span></div>

Refer to Spaces for more information.

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

patch/api/pinned_event

Request body

eventIdstring required

The _id of the associated event for this pinned event.

pinnedEventIdstring nullable

The savedObjectId of the pinned event you want to unpin.

timelineIdstring required

The savedObjectId of the timeline that you want this pinned event unpinned from.

Example request

{
  "eventId": "d3a1d35a3e84a81b2f8f3859e064c224cdee1b4bc",
  "pinnedEventId": "10r1929b-0af7-42bd-85a8-56e234f98h2f3",
  "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e"
}

Response

Indicates a successful call.

OR

Example response

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