Update an alert contact Beta
PATCH /api/v1/alerting/contacts/{id}
Change a contact's name, its addresses, or both. Send only what you want to change. PUT does the same thing.
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.
Body
| Field | Type | Description |
|---|---|---|
name optional | string | A new name, up to 120 characters. Leave it out to keep the current one. |
methods optional | object[] | Replaces the whole list of addresses. Same shape and rules as create. |
- An address that is in both the old and new list is kept: its opt-out state stays as it was, and its
severityis updated to what you sent. - An address you leave out is removed, along with its opt-out state.
- Leaving
methodsout entirely keeps every address as it is. - Re-adding an address that opted out does not start alerting it again if it is still in the list. Only a person who was fully removed and added back starts fresh.
Request
Response
200 · application/json
- {
- "contact": {
- "id": "ct_5b8d1f0a9c2e4d6f7a83",
- "name": "Night shift (EMEA)",
- "methods": [
- { "id": "318", "kind": "email", "target": "[email protected]", "severity": "high", "optedOut": false }
- ],
- "createdAt": "2026-09-17T09:02:11.000Z",
- "updatedAt": "2026-09-17T11:24:03.000Z"
- },
- "usage": { "used": 45, "dailyLimit": 100, "tier": "free" }
- }
Errors
| Status | When |
|---|---|
400 | An empty name, no address left, an address that isn't a valid email, or an invalid severity or kind. |
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. |
404 | No contact with that id in your 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
- Get a contact: read it back
- Delete a contact: remove it altogether
- Alerting: what opting out means