Method Documentation > Users and Workspaces
User Group Delete POST DELETE
Description
Delete an existing user group.
URL
All responses are in JSON format by default, to specify an XML response add “.xml” to the end of the method name (in this case “user_group_delete”)
https://<your subdomain>.<your domain>/api/user_group_delete
Restrictions
The calling user must have:
- Admin privileges for the site.
Parameters
Bold indicates required.
| Parameter | Description |
|---|---|
| api_key | Your API Key. |
| user_group_id | The ID of the user group being deleted. |
| timestamp | The current time in Unix timestamp format. |
| signature | Please see “User Authentication” for more information. |
Sample Response
Successful response In JSON:
{"userGroupDeleted":{"userGroupId":10045}}
Successful response in XML:
<userGroupDeleted>
<userGroupId>10045</userId>
</userGroupDeleted>
Error response In JSON:
{"error":{
"title":"'User Group Delete Failed",
"message":"Please try again or contact customer support."}
}
Error response In XML:
<error>
<title>'User Group Delete Failed</title>
<message>Please try again or contact customer support.</message>
</error>
Methods in Users and Workspaces
- GET /user_permissions_location
- GET /users_location_access
- GET /workspace_list
- GET /workspace_info
- GET /user_list
- GET /user_info
- POST /workspace_add
- POST /workspace_delete
- POST /user_add
- POST /user_delete
- POST /user_group_add
- POST /user_group_delete
- POST /add_to_workspace
- POST /remove_from_workspace
- POST /add_to_user_group
- POST /remove_from_user_group