Update an alert team Beta
PATCH /api/v1/alerting/teams/{id}
Change a team's name or its members. 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. |
userIds optional | integer[] | Replaces the workspace members in the team. Leave it out to keep them. |
contactIds optional | string[] | Replaces the contacts in the team. Leave it out to keep them. |
After the change the team must still have at least one person. Send [] for one list only if the other still has somebody in it.
Request
Response
200 · application/json
- {
- "team": { "id": "tm_2c7e91a4b6d0f3e85a17", "name": "Support (EMEA)", "userIds": [42],
- "users": [{ "id": 42, "name": "Sam Taylor", "email": "[email protected]" }],
- "contactIds": ["ct_5b8d1f0a9c2e4d6f7a83"],
- "contacts": [{ "id": "ct_5b8d1f0a9c2e4d6f7a83", "name": "Night shift" }], … },
- "usage": { "used": 51, "dailyLimit": 100, "tier": "free" }
- }
Errors
| Status | When |
|---|---|
400 | An empty name, an unknown contact id, or a change that would leave the team empty. |
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 team 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 team: read it back
- Delete a team: remove it