Skip to main content
POST
Create a sequence

Authorizations

Authorization
string
header
required

Enter your API Key (sk_live_xxx or sk_test_xxx)

Headers

x-workspace-id
string<uuid>

Target workspace id (from GET /v1/workspaces). Required for multi-workspace API keys to designate which workspace to write to; omit for single-workspace keys, where it is resolved automatically. Must be within the API key scope.

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:
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:

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