Delete several alert contacts Beta
DELETE /api/v1/alerting/contacts?ids={ids}
Delete several contacts at once, for one request against your quota.
Needs an X-API-Key header whose owner has permission to manage uptime monitors in the app. The call counts once against your daily quota. See Monitoring API: getting started for authentication, rate limits and errors.
Query parameters
| Name | Type | Description |
|---|---|---|
ids required | string | Comma list of contact ids, up to 500. |
Request
Response
200 · application/json
- {
- "deleted": ["ct_5b8d1f0a9c2e4d6f7a83"],
- "notFound": ["ct_0000000000000000000a"],
- "usage": { "used": 47, "dailyLimit": 100, "tier": "free" }
- }
Ids that aren't in your workspace are listed in notFound and don't fail the call.
Errors
| Status | When |
|---|---|
400 | No ids parameter. |
401 | The API key is missing or invalid. |
403 | The key's owner doesn't have permission to change alert contacts, or the key isn't linked to a workspace. |
405 | The endpoint doesn't accept that method. |
429 | A rate limit or your daily quota was hit. Read Retry-After, in seconds. Writes are also limited to 30 a minute per key. |
500, 503 | Something went wrong, or the API is temporarily unavailable. Try again. |
Errors are JSON: { "error": "message" }. See Monitoring API errors.
Related
- Delete a contact: one at a time
- List contacts: find the ids