Customers Admin API

Disable a customer

PATCH /api/v1/customers/{uid}/disable

A disabled customer cannot sign in, and nothing is sent for it.

Parameters
uid string required path
The customer's uid.
Responses
200 The customer is disabled.
401 The token is missing or wrong (Unauthenticated.), or its user may not act on this object (Unauthorized). Without the Accept: application/json header, a missing or wrong token answers with a redirect to the sign-in page instead.
404 No customer has this uid.
Disable a customer
1 2 3
curl -X PATCH 'https://your-domain/api/v1/customers/6adaabb568fda/disable' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
1 2
$client = new Acelle\Client('https://your-domain/api/v1', 'YOUR_API_TOKEN');
$client->customer()->disable('6adaabb568fda');
Response
{
    "status": 1,
    "message": "Customer was disabled",
    "customer_uid": "6adaabb568fda"
}