Skip to main content
DELETE
Delete One Customer
Hard delete — the customer’s addresses are deleted with it (and per the AR overview, its invoices too). Prefer the reversible soft delete (PUT with deletedAt). See Deleting and archiving.

Authorizations

Authorization
string
header
required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.

Path Parameters

id
string
required

"id" is required (enter it either in parameters or request body)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

id
string

Response

Responses for DELETE /api/rest/customers/{id}

deleteCustomer
Customers · object | null

columns and relationships of "customers"