Update alert event

Updates a specific alert event. Only alert events with kind ‘note’ (user-created notes) can be updated. System-generated events are immutable to maintain audit trail integrity.

PATCH /v1/alert_events/{id}

Update alert event

cURL

curl --request PATCH \
  --url https://api.rootly.com/v1/alert_events/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "alert_events",
    "attributes": {
      "details": "<string>",
      "user_id": 123
    }
  }
}
'

200

{
  "data": {
    "id": "<string>",
    "type": "alert_events",
    "attributes": {
      "kind": "informational",
      "action": "created",
      "source": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "user_id": 123,
      "details": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Body

application/vnd.api+json

Update an alert event. Note: Only alert events with kind='note' can be updated. You cannot change the kind field.

data · object · required

Show child attributes

Response

200

application/vnd.api+json

alert event updated

data · object · required

Show child attributes