Light Mode

Ban Customer

PUT/customers/blacklist/{customer}

Last modified: 3 days ago

This endpoint allows you to ban, aka Add to blacklist, one of your customers by passing the customer as a path parameter.

:::tip[Note]
Even though banned customer won't be able to create new orders, they will still be able to login to the store.
:::

`customers.read_write`- Customers Read & Write

Path Params

customer

integer

required

The Customer ID. List of Customers ID can be found here.

reason

string

required

Explanation or rationale provided uopon requesting a ban or restriction on an account or accessibility to a service.

{
  "reason": "untrusted customer"
}

Progress In-Action(200)

Not Found(404)

Error Validation(422)

Progress In-Action

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

{
  "status": 201,
  "success": true,
  "data": {
    "message": "The Blacklist has been updated successfully",
    "code": 201
  }
}

Last modified: 3 days ago