Block a customer account

post/customer-accounts/{id}/block

Block a customer account: every session ends and sign-in stops, without saying why to the customer. A person's decision; an agent needs a person's approval for this exact call.

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:write
Graphql: Mutation.contactsCustomerAccountBlock
Sdk: contacts.customerAccount.block
Cli: contacts customer account block

Parameters

idstringrequired
In the path

Request bodyapplication/json, required

reasonstring
Default: . At most 300 characters.

Responses

200application/json
Success
object
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/customer-accounts/{id}/block' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": ""
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown