Skip to main content
POST
UpdateSettings

Authorizations

Authorization
string
header
required

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

Body

application/json

UpdateSettingsRequest updates an alert's trigger and/or its kind-specific settings. At least one of the two must be provided; whichever is omitted is left unchanged (neither can be cleared). The provided settings must match the alert's existing kind — switching an alert from one kind to another is not permitted. update_settings.at_least_one_facet // At least one of trigger or settings must be set. update_settings.trigger_requires_entity // A trigger applies to entity alerts only and cannot be set together with incident lifecycle settings.

identifier
identifier · object
required

Identifier for the config to update.

incidentLifecycle
incident_lifecycle · object
required

Settings for an incident lifecycle alert.

trigger
trigger · object | null

New entity selection. Issue and schema change alerts only. Omit to keep the current trigger; it cannot be cleared.

Response

200 - application/json

Success

UpdateSettingsResponse returns the updated alert configuration.

alert
Alert · object
required

The alert configuration that was updated.