Enroll contacts

Enrolls contacts in a sequence. Skips contacts that are blacklisted, already enrolled, or active in another sequence.

POST /sequences/{id}/enroll

Enroll contacts

cURL

curl --request POST \
  --url https://app.leonar.app/api/v1/sequences/{id}/enroll \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

201

{
  "data": {
    "enrolled": 8,
    "skipped_blacklisted": 1,
    "skipped_already_enrolled": 2,
    "skipped_active_elsewhere": 0,
    "skipped_not_found": 0
  }
}

Authorizations

Authorization · string · header · required

API key starting with leo_

Path Parameters

id · string<uuid> · required

Sequence ID

Body

application/json

Option 1

Option 2

contact_ids · string<uuid>[] · required

Simple format - list of contact IDs

Maximum array length: 500

Response

201

application/json

Enrollment results

data · object

Show child attributes