Function deleteCustomer

deleteCustomer<ThrowOnError extends boolean = true>(
options: Options<DeleteCustomerData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Delete customer Deletes a customer record based on the unique customer ID.

Any one of the following roles is required for this endpoint:

Legacy Role Equivalent Permission Set Role

org.user.customer.delete org.permission.customer.delete
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteCustomerData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/api/sdk.gen.ts:2241