Skip to main content
POST
Block a customer on a channel

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Body

application/json
channel_id
integer
required

The channel identifier the customer is being blocked on.

customer_id
integer
required

The customer identifier to block.

reason
enum<string>
required

The reason of the blacklist entry.

Available options:
rate_limit,
llm_spam,
manual,
security_threat,
abusive_language
ttl_seconds
integer | null

Block duration in seconds. Omit or pass null to block permanently.

Required range: x >= 1
note
string | null

Optional note to attach to the blacklist entry.

Maximum string length: 1000
metadata
string[] | null

Optional metadata to attach to the blacklist entry.

Response

success
string
required
data
ChannelBlacklistResource · object
required