Skip to main content
DELETE
Delete One Customer By Source System Id
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.

Query Parameters

sourceSystem
string

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

sourceSystemId
string

"sourceSystemId" 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

sourceSystem
string
sourceSystemId
string

Response

Responses for DELETE /api/rest/customers

deleteCustomer
CustomersMutationResponse · object | null

response of any mutation on the table "customers"