POST
/
sequences
/
{id}
/
contacts
/
bulk
Bulk add contacts to sequence
curl --request POST \
  --url https://api.reply.io/v3/sequences/{id}/contacts/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "contactIds": [
    123
  ],
  "forcePush": false,
  "startStep": "<string>"
}'
{
  "added": [
    123,
    124,
    125
  ],
  "invalidEmailSkips": [
    126,
    127
  ],
  "ownershipSkips": [
    128
  ],
  "optOutSkips": [
    129,
    130
  ]
}

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header

Path Parameters

​
id
string
required

Sequence ID

Body

application/json
​
contactIds
integer[]
required
​
forcePush
boolean
default:false

If true, contacts will be moved from their current sequences to this one. If false, contacts will remain in their current sequences and won't be added to this one.

​
startStep
string

Optional step ID to start from

Response

Contacts added to sequence

​
added
integer[]

IDs of successfully added contacts

​
invalidEmailSkips
integer[]

Contact IDs that were skipped due to invalid email addresses

​
ownershipSkips
integer[]

Contact IDs that were skipped due to ownership restrictions

​
optOutSkips
integer[]

Contact IDs that were skipped due to opt-out status