Skip to main content
POST
Validates which customers can be deleted and returns counts of deletable and non-deletable customers.

Headers

Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
ids
number[]
required

Array of customer IDs to delete

Example:
skipUndeletable
boolean
default:false

When true, undeletable customers will be skipped and only deletable ones removed.

Response

200 - application/json

Validation completed. Returns counts and IDs of deletable and non-deletable customers.

deletableCount
number
required

Number of customers that can be deleted

Example:

2

nonDeletableCount
number
required

Number of customers that cannot be deleted

Example:

1

deletableIds
number[]
required

IDs of customers that can be deleted

Example:
nonDeletableIds
number[]
required

IDs of customers that cannot be deleted

Example: