Skip to main content
POST
/
records
/
purge
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "deleted": 123
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Body

application/json
​
confirm
boolean
required

Must be true to erase ALL records for the organization.

Response

The number of records deleted.

​
success
boolean
required
​
data
object
required
​
message
string
​
errors
object[]