SaaSFlow
DevelopersAPIReferencecustomers

Batch delete

Delete many customers in one call. selection works two ways: mode: "ids" with an explicit list, or mode: "filter" with the same filter the list endpoint…

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/customers/batch_delete

Authorization

Authorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

In: header

Path Parameters

companyId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/companies/string/customers/batch_delete" \  -H "Content-Type: application/json" \  -d '{    "selection": {      "mode": "ids",      "ids": [        "string"      ]    }  }'
{  "success": true,  "affected": 0}

Update customer

Update a customer. Only the fields you send change. Changing defaultCategorization affects future categorizations only; transactions already categorized…

Merge

Merge duplicate customers into one, in a single transaction. Creates the customer described by newCustomer, repoints the transaction categorizations…