Ban Customer

Production

https://api.salla.dev/admin/v2

PUT

/customers/blacklist/{customer}

Customers

Last modified:2025-04-13 08:52:02

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

Note

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

Scopes

customers.read_write- Customers Read & Write

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.salla.dev/admin/v2/customers/blacklist/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "untrusted customer"
}'

Response Example

200 - Example

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

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

customer

integer

required

Unique identifier assigned to the Customer. List of Customers IDs 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.

Examples

Responses

🟢200Progress In-Action

application/json

Body

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.

🟠404Not Found

🟠422Error Validation

🟠401Unauthorized

Modified at 2025-04-13 08:52:02

Delete Customer

Un-Ban customer