Add prospects to a sequence

post/crm/sequences/{id}/enroll

Add prospects to a sequence. Anyone who is suppressed, erased, without an address for the first step, or without a recorded basis for being written to is skipped, with the reason.

Before you call

Credential: Authorization: Bearer $KEY
Scope: campaigns:write
Graphql: Mutation.campaignsSequenceEnroll
Sdk: campaigns.sequence.enroll
Cli: campaigns sequence enroll

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

contactIdslist of string (uuid)required

Responses

200application/json
Success
- enrolledlist of string (uuid)required
- skippedlist of objectrequired
  - contactIdstring (uuid)required
  - reasonstringrequired
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/sequences/{id}/enroll' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "contactIds": [
    "string"
  ]
}'

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

This page as Markdown