Record that a person does not want messages

post/phone/opt-out

Record that a person does not want messages. They stay off the list until they opt back in.

Before you call

Credential: Authorization: Bearer $KEY
Scope: voice:write
Mcp: rivier_phone_opt_out
Graphql: Mutation.voicePhoneContactOptOut
Sdk: voice.phoneContact.optOut
Cli: voice phone contact opt out

Request bodyapplication/json, required

peerstringrequired
Pattern: ^+\d{6,15}$.
channelstring
One of: sms, mms, whatsapp. Default: sms.

Responses

200application/json
Success
- idstringrequired
- channelstringrequired
  One of: sms, mms, whatsapp.
- peerstringrequired
- optedInbooleanrequired
- optInSourcestringrequired
- optInAtstring or nullrequired
- optedOutAtstring or nullrequired
- lastInboundAtstring or nullrequired
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/phone/opt-out' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "peer": "string"
}'

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

This page as Markdown