Skip to main content

Delete a User Group

Delete an existing user group.

HTTP Request

DELETE/api/users/groups/:id

Authorization

Authorization

  • Required: Yes
  • Permission: Staff or Admin
  • Authentication: Token-based (Authorization: Token <your_api_key>)

Path Parameters

ParameterTypeRequiredDescription
idIntegerYesUnique ID of the user group to delete

Example Requests

1import requests
2
3response = requests.delete('http://www.example.com/api/users/groups/123', 
4  headers={'Authorization': 'Token <your_api_key>'}
5)
6print(response.status_code)  # Should be 204 for successful deletion

Status Codes

CodeDescription
204User group deleted successfully
401Unauthorized — authentication required
403Forbidden — insufficient permissions
404Not found — user group does not exist
500Internal server error

Response Fields

FieldTypeDescription
NoneNoneNo response body returned