Delete a group

Deletes an existing group. The operation returns the deleted group information and all of its users.

Note: The Collections Window, Notes, Advanced Payment Manager, Payment Plans, and Statement Generator features are entering end of support on June 3, 2024. For more information, please refer to the Product and Feature End of Support page.

Request
query Parameters
group_name
required
string

The name of the group.

Example: group_name=NYC Office
header Parameters
API-Token
required
string

The API token that is shown in the settings of Notes. It is a 64-digit hex number.

Example: a48865e51c3f4610de8f319bdd7bf691b2aaad827ed31ad1dd6847e617200666
Responses
200
delete/api/v1/groups/{group_name}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "id": 113,
  • "name": "NYC Office",
  • "description": "Engineers in NYC",
  • "created_at": "2020-02-12T21:50:59.774Z",
  • "updated_at": "2020-02-12T21:50:59.774Z",
  • "users": [
    ]
}