Skip to navigation

Delete a customer

View as Markdown

Deletes a customer that has no locations. A search by its client_reference_id no longer finds it, and its host stops resolving. Needs a key that is not limited to one customer.

Scope: customers:write.

Authentication

AuthorizationBearer

A restricted API key, tc_rk_live_ and 32 characters. Send it as Authorization: Bearer <key>. A key lists its scopes, and each operation below names the one it needs; a key may also be limited to one customer. An owner or a developer of the organization makes a key in the dashboard, under API keys, after a code sent to their e-mail. The key is shown once, when it is made. An owner or a developer can revoke it there, and a revoked key stops working within a minute.

Path parameters

customerstringRequired
The customer's id.

Response

The customer was deleted.
deletedboolean
idstring
objectstring

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error