Create a offboarding request
POST
/v1/tenants/current/offboarding-requestscurl -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
}'认证
每个请求都需要携带个人访问令牌（PAT）。
- Authorization: Bearer PAT
请求头参数
- 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.
请求体
Content-Typeapplication/json
- reasonstring | null
- exportWindowDaysnumber
- retentionDaysnumber
响应
Success
- dataobject必填
- idstring必填
- tenantIdstring必填
- statusstring必填可选值pendingactivecancelledcompleted
- requestedBystring必填
- requestedAtstring必填
- exportWindowEndsAtstring必填
- retentionEndsAtstring必填
- cancelledAtstring | null必填
- completedAtstring | null必填
- reasonstring | null必填
- createdAtstring必填
- updatedAtstring必填
- metaobject必填
- requestIdstring必填
响应示例
{
"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"
}
}服务器https://api.embodiflow.io/v1https://api.embodiflow.dev/v1