Skip to main content
POST
/
api
/
service
/
customer
/
delete
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);
{
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

Use this file to discover all available pages before exploring further.

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