Skip to main content
POST
/
sequences
/
{id}
/
contacts
Add contact to sequence
curl --request POST \
  --url https://api.reply.io/v3/sequences/{id}/contacts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "contactId": 123,
  "forcePush": false,
  "startStepId": 123
}
'
{
  "id": 12345,
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "title": "Senior Product Manager",
  "company": "Tech Solutions Inc",
  "domain": "company.com",
  "city": "San Francisco",
  "state": "CA",
  "country": "United States",
  "timeZone": "America/Los_Angeles",
  "phone": "+1-415-555-0123",
  "phoneStatus": "verified",
  "linkedInProfile": "https://www.linkedin.com/in/johndoe",
  "linkedInSalesNavigator": "https://www.linkedin.com/sales/profile/123456",
  "linkedInRecruiter": "https://www.linkedin.com/recruiter/profile/789012",
  "companySize": "501-1000",
  "industry": "Software & Technology",
  "notes": "Met at SaaS Conference 2024",
  "addingDate": "2024-03-08T10:00:00Z",
  "customFields": [
    {
      "key": "leadSource",
      "value": "Conference"
    },
    {
      "key": "budget",
      "value": "100k-250k"
    }
  ]
}

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

Either provide an existing contactId to add to the sequence, or provide a contact object. If a contact object is provided and the contact doesn't exist in the system, a new contact will be created before being added to the sequence.

​
contactId
integer
required

Existing contact ID to add to the sequence

​
forcePush
boolean
default:false

If true, the contact will be moved from their current sequence to this sequence. If false, the contact will remain in their current sequence and won't be added to this sequence.

​
startStepId
integer

Optional step ID to start from

Response

Contact added to sequence

​
firstName
string
required

First name

​
id
integer

Unique ID

​
email
string<email>

Primary email address

​
lastName
string

Last name

​
phone
string

Phone number

​
title
string

Job title

​
company
string

Organization name

​
companySize
string

Organization employee count

​
industry
string

Business sector

​
linkedInProfile
string<uri>

LinkedIn profile URL

​
linkedInSalesNavigator
string<uri>

Sales Navigator URL

​
linkedInRecruiter
string<uri>

Recruiter URL

​
city
string

City of residence

​
state
string

State/province

​
country
string

Country

​
timeZone
string

Timezone identifier

​
domain
string

Email domain

​
phoneStatus
string

Phone validation status

​
notes
string

Additional information

​
addingDate
string<date-time>

Creation timestamp

​
customFields
object[]

User-defined fields