Salla Docs
Merchant API
Partner APIs
Storefront
Salla CLI
Salla Docs
    Light Mode

    Ban Customer

    PUT/customers/blacklist/{customer}
    Last modified: 6 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

    Request

    Path Params
    customer
    integer 
    required

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

    Body Params application/json
    reason
    string 
    required

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

    Example
    {
  "reason": "untrusted customer"
}

    Request samples

    Responses

    Progress In-Action(200)
    Not Found(404)
    Error Validation(422)
    Progress In-Action
    HTTP Code: 200
    Content Type : JSONapplication/json
    Data Schema
    No schema defined
    Example
    {
  "status": 201,
  "success": true,
  "data": {
    "message": "The Blacklist has been updated successfully",
    "code": 201
  }
}
    Last modified: 6 days ago