BlendFi
APIUsers

Soft-delete a user

DELETE
/v1/users/{id}
AuthorizationBearer <token>

Paste your BlendFi API key. Sandbox keys start with sk_test_. The Bearer prefix is added automatically.

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

idempotency-key*string

Client-generated unique key to make the mutation safe to retry.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://api.sandbox.blendfi.com.br/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "idempotency-key: 0196c5d9-2e34-7c24-a47e-a0e1f89bb8a9"
Empty

{
  "code": "idempotency_key_required",
  "message": "Idempotency-Key header is required for this method.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

{
  "code": "authentication_required",
  "message": "No valid credentials provided.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

{
  "code": "missing_capability",
  "message": "Your API key does not have the required capability for this endpoint.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}
{
  "code": "user_not_found",
  "message": "User not found.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

{
  "code": "idempotency_key_reused",
  "message": "Idempotency-Key was previously used with a different request body.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}

{
  "code": "rate_limit_exceeded",
  "message": "Too many requests. Try again after the retry_after_seconds window.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG",
  "details": {
    "retry_after_seconds": 60
  }
}
{
  "code": "internal_error",
  "message": "Internal server error.",
  "request_id": "01KPR9F6MM8G147177J7ZQPJHG"
}