Skip to the page

Praecise Platform

Rivier/ Reference/ contacts

Lift a suppression, with the reason it is lifted

post/crm/suppressions/remove

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:admin
Graphql: Mutation.contactsSuppressionRemove
Sdk: contacts.suppression.remove
Cli: contacts suppression remove

Request bodyapplication/json, required

channelstringrequired
One of: email, sms, whatsapp, phone.
valuestringrequired
At most 320 characters.
reasonstringrequired
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/crm/suppressions/remove' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "channel": "email",
  "value": "string",
  "reason": "string"
}'

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

This page as Markdown