Delete A Workspace

DELETE

/v2/workspaces

Deletes one or more workspaces owned by the account the API key belongs to. Each workspace is checked on its own, so some can be deleted while others are rejected. The response lists which workspaces were deleted and which weren't, with a reason for each.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://api.zapmail.ai/api/v2/workspaces' \
--header 'x-auth-zapmail: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "workspaceIds": [
    "3f1c2a7e-8b4d-4c6a-9e2f-1a2b3c4d5e6f",
    "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
  ]
}'

Response Example

{
  "status": 200,
  "message": "Workspace deleted successfully",
  "data": {
    "deletedWorkspaces": ["3f1c2a7e-8b4d-4c6a-9e2f-1a2b3c4d5e6f"],
    "notDeletedWorkspaces": []
  }
}

Modified at 2026-10-07 12:34:45

Quick Setup

Retrieve all workspaces