Method Documentation > Users and Workspaces
Workspace Delete POST
Description
Deletes a workspace, including all files in that workspace.
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 “workspace_delete”)
https://<your subdomain>.<your domain>/api/workspace_delete
Restrictions
The calling user must have:
- Admin privileges for the site.
Parameters
Bold indicates required.
| Parameter | Description |
|---|---|
| workspace_id | The ID of the workspace to be deleted. |
| api_key | Your API Key. |
| timestamp | The current time in Unix timestamp format. |
| signature | Please see “User Authentication” for more information. |
Sample Response
Successful response In JSON:
{"workspaceDelete":{"workspaceId":1}}
Successful response in XML:
<workspaceDelete>
<workspaceId>1</workspaceId>
</workspaceDelete>
Error response In JSON:
{"error":{
"title":"'Workspace Delete Failed",
"message":"You must be an administrator to call this method"}
}
Error response In XML:
<error>
<title>'Workspace Delete Failed</title>
<message>You must be an administrator to call this method</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