Persists a pinned event to a timeline.

PATCH /api/pinned_event

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

Body Required

The pinned event to persist or update along with additional metadata.

eventId string Required
pinnedEventId string | null
timelineId string Required

Responses

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

Indicate the event was successfully pinned in the timeline.
Hide response attribute Show response attribute object
- data object Required
  
  Hide data attribute Show data attribute object
  
  persistPinnedEventOnTimeline object Required
  
  Hide persistPinnedEventOnTimeline attributes Show persistPinnedEventOnTimeline attributes object
  
  created number | null
  
  createdBy string | null
  
  eventId string Required
  
  pinnedEventId string Required
  
  timelineId string Required
  
  updated number | null
  
  updatedBy string | null
  
  version string Required
  
  code number
  
  message string

PATCH /api/pinned_event

curl \
 -X PATCH http://localhost:5622/api/pinned_event \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"

Request examples

{
  "eventId": "string",
  "pinnedEventId": "string",
  "timelineId": "string"
}

Response examples (200)

{
  "data": {
    "persistPinnedEventOnTimeline": {
      "created": 42.0,
      "createdBy": "string",
      "eventId": "string",
      "pinnedEventId": "string",
      "timelineId": "string",
      "updated": 42.0,
      "updatedBy": "string",
      "version": "string",
      "code": 42.0,
      "message": "string"
    }
  }
}