Skip to main content
POST
Bulk add contacts to sequence

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

id
integer
required

Sequence ID

Body

application/json
contactIds
integer[]
required

Array of contact IDs to add

removeFromExisting
boolean
default:false

If true, contacts will be removed from their current sequences before being added to this one

startStepId
integer | null

Optional step ID to start from

ignoreStepDelay
boolean
default:false

If true, skip the configured delay before the first step and start processing immediately

startFrom
string<date-time> | null

Optional date when contact processing should begin. If not provided, processing starts immediately.

Response

Contacts added to sequence.

Per-item failures use the SequenceContactError enum. Common per-item slugs:

added
integer[]

IDs of successfully added contacts

notProcessed
object

Contacts that could not be added, keyed by contact ID