Create a offboarding request

POST

/v1/tenants/current/offboarding-requests

curl -X POST 'https://api.embodiflow.io/v1/tenants/current/offboarding-requests' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "reason": "string",
    "exportWindowDays": 0,
    "retentionDays": 0
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

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

reasonstring | null
exportWindowDaysnumber
retentionDaysnumber

Responses

Success

dataobjectrequired
- idstringrequired
- tenantIdstringrequired
- statusstringrequired
  Allowed values
  pending
  active
  cancelled
  completed
- requestedBystringrequired
- requestedAtstringrequired
- exportWindowEndsAtstringrequired
- retentionEndsAtstringrequired
- cancelledAtstring | nullrequired
- completedAtstring | nullrequired
- reasonstring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
metaobjectrequired
- requestIdstringrequired

Response example

{
  "data": {
    "id": "string",
    "tenantId": "string",
    "status": "pending",
    "requestedBy": "string",
    "requestedAt": "string",
    "exportWindowEndsAt": "string",
    "retentionEndsAt": "string",
    "cancelledAt": "string",
    "completedAt": "string",
    "reason": "string",
    "createdAt": "string",
    "updatedAt": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1