Skip to main content
POST
/
workspaces
/
{workspaceID}
/
sequences
Error
A valid request URL is required to generate request examples
{
  "agentId": "<string>",
  "bouncedCount": 123,
  "bouncedPercent": 123,
  "clickTrackingEnabled": true,
  "clickedCount": 123,
  "clickedPercent": 123,
  "companyOutreachLimitCount": 123,
  "companyOutreachLimitEnabled": true,
  "completedCount": 123,
  "completedPercent": 123,
  "contactedCount": 123,
  "id": "<string>",
  "leadCount": 123,
  "localizedOptOutEnabled": true,
  "mailboxes": [
    {
      "address": "<string>",
      "firstName": "<string>",
      "id": "<string>",
      "lastName": "<string>"
    }
  ],
  "name": "<string>",
  "openTrackingEnabled": true,
  "openedCount": 123,
  "openedPercent": 123,
  "productId": "<string>",
  "repliedCount": 123,
  "repliedPercent": 123,
  "repliedPositiveCount": 123,
  "repliedPositivePercent": 123,
  "sequentialCompanySendingEnabled": true,
  "steps": [
    {
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "variants": [
        {
          "distributionWeight": 123,
          "dynamicLanguageEnabled": true,
          "emailContent": "<string>",
          "emailSubject": "<string>",
          "id": "<string>",
          "isGenerated": true,
          "label": "<string>",
          "order": 123,
          "overdriveEnabled": true
        }
      ],
      "waitDays": 123
    }
  ],
  "workspaceId": "<string>"
}
{
"data": [
{
"id": "<string>",
"name": "<string>",
"sentCount": 123,
"sequenceId": "<string>",
"url": "<string>"
}
],
"message": "<string>"
}

Authorizations

Authorization
string
header
required

Path Parameters

workspaceID
string
required

Workspace ID

Body

application/json

Request body

Request body

language
enum<string>
required
Available options:
russian,
ukrainian,
finnish,
american_english,
british_english,
french,
spanish,
polish,
romanian,
german,
lithuanian,
dutch,
latvian,
italian,
czech,
hungarian,
japanese,
brazilian_portugese,
swedish,
danish,
norwegian,
estonian
name
string
required
Example:

"My Sequence"

productId
string
required
Example:

"prod_123456"

timezone
string
required
Example:

"America/New_York"

Response

Created sequence

agentId
string
bouncedCount
integer
bouncedPercent
number
clickTrackingEnabled
boolean
clickedCount
integer
clickedPercent
number
companyOutreachLimitCount
integer
companyOutreachLimitEnabled
boolean
completedCount
integer
completedPercent
number
contactedCount
integer
id
string
leadCount
integer
localizedOptOutEnabled
boolean
mailboxes
object[]
name
string
openTrackingEnabled
boolean
openedCount
integer
openedPercent
number
productId
string
repliedCount
integer
repliedPercent
number
repliedPositiveCount
integer
repliedPositivePercent
number
sequentialCompanySendingEnabled
boolean
status
enum<string>
Available options:
active,
draft,
paused,
deleted,
completed,
video_pending,
active,
paused
steps
object[]
workspaceId
string