Skip to main content
POST
Ban customer
Required scopes: customers.ban:rw

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
id
string
required

The customer ID.

ban
object
required

The ban details.

Response

200

Customer banned.