Pin an event Beta

PATCH /api/pinned_event

Pin an event to an existing Timeline.

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

Body Required

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

Responses

PATCH /api/pinned_event
curl \
 -X PATCH https://localhost:5601/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",
      "timelineId": "string",
      "updated": 42.0,
      "updatedBy": "string",
      "pinnedEventId": "string",
      "version": "string",
      "code": 42.0,
      "message": "string"
    }
  }
}