Privacy
Schedule Workspace Deletion
Schedule the deletion of this workspace and everything in it, `PRIVACY_DELETION_GRACE_DAYS` (default 7) from now; cancellable until then. Confirm with the workspace's slug. The owner only, signed in (API keys get 403).
API key access
Not available to API keys or connected apps: only a signed-in person can call this route.
POST
/api/v1/workspaces/current/privacy/deletionAuthorizationBearer <token>
Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Header Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
confirmstring
The workspace's slug, typed to confirm.
Length
1 <= length <= 200Response Body
curl -X POST "http://localhost:8000/api/v1/workspaces/current/privacy/deletion" \ -H "X-Workspace-Id: string" \ -H "Content-Type: application/json" \ -d '{ "confirm": "string" }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "lead_export",
"status": "pending",
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
"requested_by_email": "string",
"export": {},
"scheduled_for": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"result": {
"property1": null,
"property2": null
},
"error": "string",
"created_at": "2019-08-24T14:15:22Z"
}Empty
Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}