Skip to the page

Praecise Platform

Rivier/ Reference/ contacts

Export contacts as CSV

post/crm/export

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:admin
Sdk: contacts.export.run
Cli: contacts export run

Request bodyapplication/json, required

rulesobject
segmentIdstring (uuid)
tagstring
At most 40 characters.
maxinteger
At least 1. At most 100000.

Responses

200text/csv
Success
string
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/export' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "rules": {
    "all": []
  },
  "segmentId": "string",
  "tag": "string",
  "max": 0
}'

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

This page as Markdown