Skip to the page

Praecise Platform

Rivier/ Reference/ contacts

How many people match a rule or segment, and a few of them

post/crm/segments/preview

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:read
Graphql: Query.contactsSegmentPreview
Sdk: contacts.segment.preview
Cli: contacts segment preview

Request bodyapplication/json, required

rulesobject
segmentIdstring (uuid)
tagstring
At most 40 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/segments/preview' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "rules": {
    "all": []
  },
  "segmentId": "string",
  "tag": "string"
}'

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

This page as Markdown