Contacts bulk recipients compile

post/crm/bulk/recipients

Compile a multi-select of segments, lists, tags and individual contacts, less exclusions, into one audience rule and count it live: matched, able to receive, and without consent.

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:read
Graphql: Query.contactsBulkRecipientsCompile
Sdk: contacts.bulkRecipients.compile
Cli: contacts bulk recipients compile

Request bodyapplication/json, required

segmentIdslist of string (uuid)
listslist of string
contactIdslist of string (uuid)
tagslist of string
excludeSegmentIdslist of string (uuid)
channelstring
One of: email, sms, whatsapp. Default: email.

Responses

200application/json
Success
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/bulk/recipients' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "segmentIds": [
    "string"
  ],
  "lists": [
    "string"
  ],
  "contactIds": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "excludeSegmentIds": [
    "string"
  ],
  "channel": "email"
}'

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

This page as Markdown