v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Sequence Contacts

Bulk add contacts to sequence

<small>Requires the sequences:operate scope (or a broader one that includes it).</small>

Add multiple contacts to the sequence at once

post/v3/sequences/{id}/contact-links/bulk

idinteger required

Sequence ID

contactIdsinteger[] required

Array of contact IDs to add

removeFromExistingboolean

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

startStepIdinteger nullable

Optional step ID to start from

ignoreStepDelayboolean

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

startFromstring date-time nullable

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

Contacts added to sequence.

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

Slug	Meaning
invalidInput	Generic validation failure for this contact
contactLimitExceeded	Plan limit reached
contactAlreadyInSequence	Contact is already enrolled
contactNotFound	Contact does not exist
forbidden	Caller lacks permission for this contact

addedinteger[]

IDs of successfully added contacts

notProcessedobject

Contacts that could not be added, keyed by contact ID