Update an alert

patch

https://api.doit.com/analytics/v1/alerts/{id}

Updates the alert specified by the Id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Alert ID

Body Params

Partial update. Only supplied fields change. Recipient-only and config-field-only requests are supported. Identical effective updates preserve updateTime and the notification revision. Empty recipient arrays now clear destinations instead of being ignored; direct API clients relying on the previous behavior must omit those fields instead.

name

string

length between 1 and 64

Alert name

config

object

Only supplied configuration fields change. A zero value is a valid threshold. Fields cannot be null except ignoreValuesRange.

recipientsSlackChannels

array of objects

length ≤ 50

Slack destinations. Omitted on create means none; omitted on PATCH preserves saved channels; an array replaces them and [] clears them. Null is rejected. Order is preserved as submitted and repeated destinations are collapsed. At least one email or Slack destination must remain. Discover eligible destinations with listAlertSlackChannels.

recipientsSlackChannels

recipients

array of strings

Email destinations. Omission preserves saved emails; an array replaces them; [] clears them and requires a Slack destination in the resulting alert. Null is rejected.

recipients

Responses

409

The alert changed during the update. Retrieve it and retry against its latest settings.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK - Alert updated.

400Bad Request - The server cannot process the request, often due to a malformed request.

401Unauthorized - Invalid API key.

403Forbidden - The client is not authorized to perform the request.

404Not Found - The requested resource does not exist.