Change many contacts at once

post/crm/bulk

Change many contacts at once: tag, record consent on the ledger, add to a list, share with the organisation, archive, or move to another project. Starts as a dry run that changes nothing; set dryRun to false to apply. Consent changes need the consent permission; moves are a person's decision.

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:write
Graphql: Mutation.contactsBulkRun
Sdk: contacts.bulk.run
Cli: contacts bulk run

Request bodyapplication/json, required

selectobjectrequired
- idslist of string (uuid)
- segmentIdstring (uuid)
- tagstring
  At most 40 characters.
- searchstring
  At most 200 characters.
actionobjectrequired
dryRunboolean
Default: true.

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' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "select": {
    "ids": [
      "string"
    ],
    "segmentId": "string",
    "tag": "string",
    "search": "string"
  },
  "action": {
    "type": "tag_add",
    "tags": [
      "string"
    ]
  }
}'

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

This page as Markdown