Skip to main content
POST
/
v1
/
sequences
Create a sequence
curl --request POST \
  --url https://api.example.com/v1/sequences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Sales Sequence",
  "assignedToIds": [
    "123e4567-e89b-12d3-a456-426614174001",
    "123e4567-e89b-12d3-a456-426614174002"
  ],
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "contactIds": [
    "123e4567-e89b-12d3-a456-426614174010",
    "123e4567-e89b-12d3-a456-426614174011"
  ]
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Sales Sequence",
  "organizationMembershipId": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "contactCount": 150,
  "assignedTo": [
    {
      "organizationMembershipId": "123e4567-e89b-12d3-a456-426614174000",
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Enter your API Key (sk_live_xxx or sk_test_xxx)

Body

application/json
​
name
string
required

Sequence name

Example:

"My Sales Sequence"

​
assignedToIds
string[]
required

OrganizationMembership IDs of users to assign this sequence to

Example:
[
  "123e4567-e89b-12d3-a456-426614174001",
  "123e4567-e89b-12d3-a456-426614174002"
]
​
creatorId
string
required

OrganizationMembership ID of the creator. Use the /users endpoint to get available organizationMembershipIds.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
contactIds
string[]

Contact IDs to add to the sequence

Example:
[
  "123e4567-e89b-12d3-a456-426614174010",
  "123e4567-e89b-12d3-a456-426614174011"
]

Response

Sequence created successfully

​
id
string
required

Unique identifier of the sequence

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

Name of the sequence

Example:

"My Sales Sequence"

​
organizationMembershipId
string
required

OrganizationMembership ID of the creator

Example:

"123e4567-e89b-12d3-a456-426614174001"

​
createdAt
string<date-time>
required

Date when the sequence was created

Example:

"2024-01-15T10:30:00.000Z"

​
updatedAt
string<date-time>
required

Date when the sequence was last updated

Example:

"2024-01-15T10:30:00.000Z"

​
contactCount
number

Number of contacts in the sequence

Example:

150

​
assignedTo
object[]

List of users assigned to this sequence