Customer DELETE API Documentation

Deleting a Customer

Endpoint: DELETE /admin/customers/{customer_id}

Purpose

This API allows administrators to delete a customer record from the system. The /admin/customers/{customer_id} endpoint permanently removes the specified customer and all associated data.

Path Parameters

Parameter	Type	Description
customer_id	Integer	Unique identifier of the customer

Query Parameters

No query parameters for this endpoint.

Use Case

This API is used when an administrator needs to remove a customer from the system. It ensures that customer records that are no longer needed can be deleted, helping businesses maintain a clean and manageable customer database. Use this endpoint with caution, as deleted customer data cannot be recovered.

Request Body

This endpoint does not require a request body.

Response

This endpoint does not return a response body. Upon successful deletion, an HTTP status code 204 No Content is returned, indicating that the customer has been removed successfully.

DELETE

https://{your_site_domain}/api/v4/admin/customers/{customer_id}

Try It Out