Delete a Customer

Delete a Customer by wiping personal data and marking the customer as deleted.

POST /api/service/customer/delete

JavaScript

JavaScript

import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});

const customer = await client.customers.delete({ id: 'id' });

console.log(customer.success);

200

{
  "success": true
}

Authorizations

X-Ivy-Api-Key · string · header · required

API key for authentication

Headers

Idempotency-Key · string

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Body

application/json

id · string · required

The id of the customer

Response

200 - application/json

Successful response

success · boolean · required

Indicates whether the customer deletion was successful