Salla Docs
Merchant API
Partner APIs
Storefront
Salla CLI
Salla Docs

    [lightMode]

    Ban Customer

    PUT/customers/blacklist/{customer}
    [updatedIn] 8 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

    Authorization: OAuth 2.0
    Add the parameter
    Authorization
    to [header]    ，whose value is to concatenate the Token after the Bearer.
    [api.label.example]
    Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
    [message.pathParameter]
    customer
    integer 
    required

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

    [message.bodyParameter]application/json
    reason
    string 
    required

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

    [api.label.example]
    {
  "reason": "untrusted customer"
}

    Request samples

    [api.label.responses]

    Progress In-Action(200)
    Not Found(404)
    Error Validation(422)
    Progress In-Action
    HTTP Code: 200
    Content Type : JSONapplication/json
    [response.label.jsonSchema]
    status
    number 
    optional

    Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

    success
    boolean 
    optional

    Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

    data
    object 
    optional
    message
    string 
    optional

    A text or data communication generated by a system or application in response to a request.

    code
    number 
    optional

    A numerical or alphanumeric identifier used in various systems and protocols to indicate the status or outcome of a specific request.

    [api.label.example]
    {
  "status": 201,
  "success": true,
  "data": {
    "message": "The Blacklist has been updated successfully",
    "code": 201
  }
}
    [updatedIn] 8 days ago