Add people to a sequence, by phone number or from a contact book
Send book_id to add everyone in a contact book who has a phone number, or people to add them one by one (up to 5,000). Anyone who opted out, has no consent where consent is required, or is already going through the sequence is left out. The sequence must have at least one message, and only an active sequence sends.
POST
https://app.softsolz.uk/api/v1/services/outreach/sequences/{id}/enrollmentsRecent Requests
Kept only in this browserTimeStatusTook
Send a request with Try it to see it here.
Path Params
idstringrequiredHeaders
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Idempotency-KeystringOptional idempotency key for safe retries.
Body Params
peoplearray of objectsPeople to add. Ignored when book_id is given.
book_idstringContact book to add everyone from.
Response
Response Body
enrolledintegerPeople added to the sequence.already_inintegerPeople already going through the sequence, so not added again.skippedarray of objectsPeople left out, grouped by reason.Request
curl --request POST \ --url https://app.softsolz.uk/api/v1/services/outreach/sequences/{id}/enrollments \ --header 'Authorization: Bearer sk_live_your_key' \ --header 'Content-Type: application/json' \ --data '{ "people": [ { "phone": "+447700900123", "display_name": "Jane Doe" } ]}'Credentials
Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.
Response · 201
{ "data": { "enrolled": 2, "already_in": 0, "skipped": [ { "reason": "opted_out", "count": 2 } ] }}