Create a deletion request
POST
/v1/tenants/current/deletion-requestscurl -X POST 'https://api.embodiflow.io/v1/tenants/current/deletion-requests' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"clientToken": "string"
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Header parameters
- Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.
Request body
Content-Typeapplication/json
- clientTokenstring | null
Responses
Success
- dataobjectrequired
- idstringrequired
- tenantIdstringrequired
- offboardingRequestIdstringrequired
- statusstringrequiredAllowed valuesqueuedsucceededfailedcancelledpauseddrainingdeleting
- triggeredBystringrequired
- triggeredAtstringrequired
- claimedAtstring | nullrequired
- drainingStartedAtstring | nullrequired
- deletingStartedAtstring | nullrequired
- completedAtstring | nullrequired
- failedAtstring | nullrequired
- retryCountnumberrequired
- lastErrorstring | nullrequired
- objectsDeletedCountnumberrequired
- firstDestructiveBatchAtstring | null
- pausedAtstring | null
- pauseReasonstring | null
- holdStopReasonstring | null
- createdAtstringrequired
- updatedAtstringrequired
- metaobjectrequired
- requestIdstringrequired
Response example
{
"data": {
"id": "string",
"tenantId": "string",
"offboardingRequestId": "string",
"status": "queued",
"triggeredBy": "string",
"triggeredAt": "string",
"claimedAt": "string",
"drainingStartedAt": "string",
"deletingStartedAt": "string",
"completedAt": "string",
"failedAt": "string",
"retryCount": 0,
"lastError": "string",
"objectsDeletedCount": 0,
"firstDestructiveBatchAt": "string",
"pausedAt": "string",
"pauseReason": "string",
"holdStopReason": "string",
"createdAt": "string",
"updatedAt": "string"
},
"meta": {
"requestId": "string"
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1