Skip to main content
POST
List customer bans
Required scopes: banlist_read

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

The body is of type object.

Response

200 - application/json

A list of active customer bans.

ip
string

The banned IP address.

customer_id
string

Unique identifier of the banned customer.

agent_id
string

The ID of the agent who issued the ban.

thread_id
string

The ID of the thread associated with the ban.

created_at
string<date-time>

The RFC 3339 date-time when the ban was created.

expires_at
string<date-time>

The RFC 3339 date-time when the ban expires.