Update Playbook Alert

Update a Playbook Alert. Generic alert properties like status, priority and assignee may be updated, or a log message may be appended.

What this endpoint does

Updates a Playbook Alert's common properties — status, priority, assignee, and reopen behavior — or appends a log message (up to 5,000 characters). All update fields are optional; include only the properties you want to change. When resolving or dismissing an alert, you can also record remediation actions taken using added_actions_taken with action IDs from the Playbook Alerts: Metadata endpoint (this field is only accepted when setting status to Dismissed or Resolved). To assign alerts, obtain valid assignee IDs from the Playbook Alerts: Available Assignees endpoint. The reopen parameter controls whether a dismissed/resolved alert should automatically reopen on significant updates.

Response data

The response contains only a status confirmation (Ok or Error) with a message. No alert data is returned — to verify the update was applied, call the Playbook Alerts: Preview endpoint or the appropriate category-specific Detail endpoint.

Path Params
string
required

The unique id of a specific Playbook Alert

Body Params

added_actions_taken can only be set when status is set to Dismissed or Resolved.

string
enum

The priority of the Playbook Alert.

Allowed:
string
enum

The status of the Playbook Alert.

Allowed:
string

ID of the assignee

string

Freetext log message. Maximum of 5000 characters.

string
enum

Reopen strategies can only be applied to alerts with a status of Dismissed or Resolved.

The following combinations of status/reopen are allowed:

  • Dismissed -> Never
  • Resolved -> Never
  • Resolved -> SignificantUpdates
Allowed:
added_actions_taken
array of objects
added_actions_taken
removed_actions_taken
array of objects
removed_actions_taken
Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json