Skip to content

Delete a workspace and everything in it

DELETE
/api/v1/workspaces/{workspaceId}
curl --request DELETE \
--url https://api.crossmart.io/api/v1/workspaces/example \
--header 'Content-Type: application/json' \
--data '{ "confirmName": "example" }'

Disconnects every store (removing the app unless another workspace uses the store), then deletes products, stock, listings, orders, activity and API keys. It cannot be undone.

workspaceId
required
string
Media typeapplication/json
object
confirmName
required

The workspace’s name, typed to confirm: deleting it cannot be undone

string
<= 200 characters

Example generated

{
"confirmName": "example"
}