Delete a Group

Delete an existing contact group (mailing list) from your address book. Once deleted, the group and its associations cannot be recovered.

DELETE /addressbook/groups/{groupID}

Required Permission

delete:Groups

Your API key must have this permission enabled in order to use this endpoint.

Path Parameters

Field	Type	Required	Description
groupID	string	Yes	The unique ID of the contact group to delete.

Example Request

curl --location --request DELETE 'https://<hostname>/addressbook/groups/aaaa-bbbb-ddddd' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace YOUR_API_KEY with your API key and groupID with the ID of the group you want to delete.

All endpoints shown in this documentation use a sample base URL. The production API endpoint is provided by our team upon request.

Responses

Success (HTTP 200)

{
  "success": true
}

Error Responses

Authentication / Authorization Error (HTTP 403)

Returned if the API key does not have the delete:Groups permission.

{
  "success": false,
  "error": "Not authorized to delete groups"
}

Group Not Found (HTTP 404)

Returned if the specified group ID does not exist.

{
  "success": false,
  "error": "Group not found"
}

This operation is permanent and cannot be undone.