Skip to main content
POST
outreach.sequence.enroll

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
sequenceId
string
required

From outreach.sequences.list.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
contactIds
string[]
required

Contacts to enrol, from outreach.contacts.list. 1 to 100.

Required array length: 1 - 100 elements
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

enrolled
number
required

How many contacts were enrolled.

failed
number
required

How many contacts were not enrolled.

results
object[]
required

One entry per contact reported on.