Delete Recipient Group

Last modified on May 14, 2021

To delete an existing recipient group, send a DELETE request to /notifier-groups/{id}, where {id} is the group ID. Note that deleting a group does not delete the monitors, recipients, or custom templates in this group.

If the deleted group was a default one, there will be no default group (unless you set one later), and monitors not in any recipient group will alert everyone.

Request URL

DELETE https://api.alertsite.com/api/v3/notifier-groups/{id}

Authentication

The request must include the Authorization header containing a user’s access token:

Authorization: Bearer ACCESS_TOKEN

See Authentication for more information.

Response body

On success, the operation returns HTTP status 204 without a request body.

Error responses have a non-204 status code and include the errors list:

{
  "errors": [
    {
      "code": 404,
      "message": "Record not found"
    }
  ]
}

Try it out

Click here to test this operation in AlertSite’s interactive API console.

Code examples

Delete the recipient group with ID 123456:

cURL

curl -X DELETE https://api.alertsite.com/api/v3/notifier-groups/123456 -H "Authorization: Bearer ACCESS_TOKEN"

Python

# Python 3.5+
import requests  # Requests library http://docs.python-requests.org
import json

baseUrl = 'https://api.alertsite.com/api/v3'
username = 'demo@example.com'  # Replace with your AlertSite login email
password = 'pa55w0rd'          # Replace with your AlertSite password
rgroup_id = 123456

# Log in
payload = {'username': username, 'password': password}
r = requests.post(baseUrl + '/access-tokens', data=json.dumps(payload), headers={'Content-Type': 'application/json'})
token = r.json()['access_token']

# Delete the recipient group
r = requests.delete(baseUrl + '/notifier-groups/{}'.format(rgroup_id), headers={'Authorization': 'Bearer ' + token})
if r.ok:
  print('Recipient group {} has been deleted.'.format(rgroup_id))
else:
  print('Could not delete recipient group {}. The following error(s) occurred:'.format(rgroup_id), *r.json()['errors'], sep='\n')

See Also

Recipient Group Operations

Highlight search results