Patch campaign subsequence

API Explorer (2.0.0)

The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.

Servers

Instantly API Server

https://api.instantly.ai/

Mock server

https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Account

An email account that can be used to send campaigns

Operations

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Lead List

A list used to store leads

Operations

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

API Key

Operations

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing items

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

idstring(uuid)read-onlyrequired

Unique identifier for the subsequence

Example: "01959271-1f8d-77ea-896b-3e8ea0fce510"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the subsequence was created

Example: "2025-03-14T02:17:22.061Z"

parent_campaignstring(uuid)required

ID of the parent campaign

Example: "01959271-1f8d-77ea-896b-3e8fd1890713"

workspacestring(uuid)read-onlyrequired

ID of the workspace this subsequence belongs to

Example: "01959271-1f8d-77ea-896b-3e900d0c335f"

statusnumberread-onlyrequired

Status of the subsequence

Enum Value	Description
0	Draft - The subsequence is in draft mode and not yet active
1	Active - The subsequence is currently running
2	Paused - The subsequence has been manually paused
3	Completed - The subsequence has finished running
4	Running Subsequences - The subsequence has active child sequences
-99	Account Suspended - The subsequence is suspended due to account issues
-1	Accounts Unhealthy - The subsequence is paused due to unhealthy sending accounts
-2	Bounce Protection - The subsequence is paused due to high bounce rates

Example: 0

timestamp_leads_updatedstring(date-time)read-onlyrequired

Timestamp when the leads were last updated

Example: "2025-03-14T02:17:22.061Z"

namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

conditionsobjectrequired

Conditions that trigger the subsequence

conditions.crm_statusArray of numbers

Example: [1,2,3]

conditions.reply_containsstring

Example: "yes"

subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

subsequence_schedule.schedulesArray of objectsnon-emptyrequired

subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

subsequence_schedule.schedules[].timingobjectrequired

subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

subsequence_schedule.schedules[].daysobjectnon-emptyrequired

subsequence_schedule.schedules[].days.0boolean

Example: true

subsequence_schedule.schedules[].days.1boolean

Example: true

subsequence_schedule.schedules[].days.2boolean

Example: true

subsequence_schedule.schedules[].days.3boolean

Example: true

subsequence_schedule.schedules[].days.4boolean

Example: true

subsequence_schedule.schedules[].days.5boolean

Example: false

subsequence_schedule.schedules[].days.6boolean

Example: false

subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

subsequence_schedule.start_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

subsequence_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

sequences[].stepsArray of objectsrequired

sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

sequences[].steps[].variantsArray of objectsrequired

sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

{
  "id": "01959271-1f8d-77ea-896b-3e8ea0fce510",
  "timestamp_created": "2025-03-14T02:17:22.061Z",
  "parent_campaign": "01959271-1f8d-77ea-896b-3e8fd1890713",
  "workspace": "01959271-1f8d-77ea-896b-3e900d0c335f",
  "status": 0,
  "timestamp_leads_updated": "2025-03-14T02:17:22.061Z",
  "name": "Follow-up sequence",
  "conditions": {
    "crm_status": [ … ],
    "reply_contains": "yes"
  },
  "subsequence_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ]
}

Create campaign subsequence

Request

Requires one of the following scopes: subsequences:create, subsequences:all, all:create, all:all

Bodyapplication/jsonrequired

The Campaign Subsequence to create

parent_campaignstring(uuid)required

ID of the parent campaign

Example: "01959271-1f8d-77ea-896b-3e8fd1890713"

namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

conditionsobjectrequired

Conditions that trigger the subsequence

conditions.crm_statusArray of numbers

Example: [1,2,3]

conditions.reply_containsstring

Example: "yes"

subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

subsequence_schedule.schedulesArray of objectsnon-emptyrequired

subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

subsequence_schedule.schedules[].timingobjectrequired

subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

subsequence_schedule.schedules[].daysobjectnon-emptyrequired

subsequence_schedule.schedules[].days.0boolean

Example: true

subsequence_schedule.schedules[].days.1boolean

Example: true

subsequence_schedule.schedules[].days.2boolean

Example: true

subsequence_schedule.schedules[].days.3boolean

Example: true

subsequence_schedule.schedules[].days.4boolean

Example: true

subsequence_schedule.schedules[].days.5boolean

Example: false

subsequence_schedule.schedules[].days.6boolean

Example: false

subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

subsequence_schedule.start_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

subsequence_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

sequences[].stepsArray of objectsrequired

sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

sequences[].steps[].variantsArray of objectsrequired

sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

curl -i -X POST \
  https://api.instantly.ai/api/v2/subsequences \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parent_campaign": "01959271-1f8d-77ea-896b-3e8fd1890713",
    "name": "Follow-up sequence",
    "conditions": {},
    "subsequence_schedule": {
      "schedules": [
        {
          "name": "My Schedule",
          "timing": {
            "from": "09:00",
            "to": "17:00"
          },
          "days": {},
          "timezone": "Etc/GMT+12"
        }
      ]
    },
    "sequences": [
      {
        "steps": [
          {
            "type": "email",
            "delay": 2,
            "variants": [
              {
                "subject": "Hello {{firstName}}",
                "body": "Hey {{firstName}},\n\nI hope you are doing well."
              }
            ]
          }
        ]
      }
    ]
  }'

Responses

The Campaign Subsequence

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the subsequence

Example: "01959271-1f8d-77ea-896b-3e8ea0fce510"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the subsequence was created

Example: "2025-03-14T02:17:22.061Z"

parent_campaignstring(uuid)required

ID of the parent campaign

Example: "01959271-1f8d-77ea-896b-3e8fd1890713"

workspacestring(uuid)read-onlyrequired

ID of the workspace this subsequence belongs to

Example: "01959271-1f8d-77ea-896b-3e900d0c335f"

statusnumberread-onlyrequired

Status of the subsequence

Enum Value	Description
0	Draft - The subsequence is in draft mode and not yet active
1	Active - The subsequence is currently running
2	Paused - The subsequence has been manually paused
3	Completed - The subsequence has finished running
4	Running Subsequences - The subsequence has active child sequences
-99	Account Suspended - The subsequence is suspended due to account issues
-1	Accounts Unhealthy - The subsequence is paused due to unhealthy sending accounts
-2	Bounce Protection - The subsequence is paused due to high bounce rates

Example: 0

timestamp_leads_updatedstring(date-time)read-onlyrequired

Timestamp when the leads were last updated

Example: "2025-03-14T02:17:22.061Z"

namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

conditionsobjectrequired

Conditions that trigger the subsequence

conditions.crm_statusArray of numbers

Example: [1,2,3]

conditions.reply_containsstring

Example: "yes"

subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

subsequence_schedule.schedulesArray of objectsnon-emptyrequired

subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

subsequence_schedule.schedules[].timingobjectrequired

subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

subsequence_schedule.schedules[].daysobjectnon-emptyrequired

subsequence_schedule.schedules[].days.0boolean

Example: true

subsequence_schedule.schedules[].days.1boolean

Example: true

subsequence_schedule.schedules[].days.2boolean

Example: true

subsequence_schedule.schedules[].days.3boolean

Example: true

subsequence_schedule.schedules[].days.4boolean

Example: true

subsequence_schedule.schedules[].days.5boolean

Example: false

subsequence_schedule.schedules[].days.6boolean

Example: false

subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

subsequence_schedule.start_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

subsequence_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

sequences[].stepsArray of objectsrequired

sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

sequences[].steps[].variantsArray of objectsrequired

sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

Response

application/json

{
  "id": "01959271-1f8d-77ea-896b-3e8ea0fce510",
  "timestamp_created": "2025-03-14T02:17:22.061Z",
  "parent_campaign": "01959271-1f8d-77ea-896b-3e8fd1890713",
  "workspace": "01959271-1f8d-77ea-896b-3e900d0c335f",
  "status": 0,
  "timestamp_leads_updated": "2025-03-14T02:17:22.061Z",
  "name": "Follow-up sequence",
  "conditions": {
    "crm_status": [ … ],
    "reply_contains": "yes"
  },
  "subsequence_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ]
}

List campaign subsequence

Request

Requires one of the following scopes: subsequences:read, subsequences:all, all:read, all:all

Query

parent_campaignstring(uuid)required

Example: parent_campaign=123e4567-e89b-12d3-a456-426614174000

limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10

starting_afterstring(uuid)

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

Example: starting_after=01956fbd-0eb1-72db-a565-82977a586084

searchstring

Example: search=test

curl -i -X GET \
  'https://api.instantly.ai/api/v2/subsequences?limit=10&parent_campaign=123e4567-e89b-12d3-a456-426614174000&search=test&starting_after=01956fbd-0eb1-72db-a565-82977a586084' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Campaign Subsequence

Bodyapplication/json

itemsArray of objects(Campaign Subsequence)required

items[].idstring(uuid)read-onlyrequired

Unique identifier for the subsequence

Example: "01959271-1f8d-77ea-896b-3e8ea0fce510"

items[].timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the subsequence was created

Example: "2025-03-14T02:17:22.061Z"

items[].parent_campaignstring(uuid)required

ID of the parent campaign

Example: "01959271-1f8d-77ea-896b-3e8fd1890713"

items[].workspacestring(uuid)read-onlyrequired

ID of the workspace this subsequence belongs to

Example: "01959271-1f8d-77ea-896b-3e900d0c335f"

items[].statusnumberread-onlyrequired

Status of the subsequence

Enum Value	Description
0	Draft - The subsequence is in draft mode and not yet active
1	Active - The subsequence is currently running
2	Paused - The subsequence has been manually paused
3	Completed - The subsequence has finished running
4	Running Subsequences - The subsequence has active child sequences
-99	Account Suspended - The subsequence is suspended due to account issues
-1	Accounts Unhealthy - The subsequence is paused due to unhealthy sending accounts
-2	Bounce Protection - The subsequence is paused due to high bounce rates

Example: 0

items[].timestamp_leads_updatedstring(date-time)read-onlyrequired

Timestamp when the leads were last updated

Example: "2025-03-14T02:17:22.061Z"

items[].namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

items[].conditionsobjectrequired

Conditions that trigger the subsequence

items[].conditions.crm_statusArray of numbers

Example: [1,2,3]

items[].conditions.reply_containsstring

Example: "yes"

items[].subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

items[].subsequence_schedule.schedulesArray of objectsnon-emptyrequired

items[].subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

items[].subsequence_schedule.schedules[].timingobjectrequired

items[].subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

items[].subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

items[].subsequence_schedule.schedules[].daysobjectnon-emptyrequired

items[].subsequence_schedule.schedules[].days.0boolean

Example: true

items[].subsequence_schedule.schedules[].days.1boolean

Example: true

items[].subsequence_schedule.schedules[].days.2boolean

Example: true

items[].subsequence_schedule.schedules[].days.3boolean

Example: true

items[].subsequence_schedule.schedules[].days.4boolean

Example: true

items[].subsequence_schedule.schedules[].days.5boolean

Example: false

items[].subsequence_schedule.schedules[].days.6boolean

Example: false

items[].subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

items[].subsequence_schedule.start_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

items[].subsequence_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

items[].sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

items[].sequences[].stepsArray of objectsrequired

items[].sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

items[].sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

items[].sequences[].steps[].variantsArray of objectsrequired

items[].sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

items[].sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a MongoDB ID, a timestamp, on an email depending on the specific API

Example: "0000-0000-0000-0000"

Response

application/json

{
  "items": [
    { … }
  ],
  "next_starting_after": "0000-0000-0000-0000"
}

Duplicate a subsequence

Request

Duplicate a subsequence with the same trigger conditions

Requires one of the following scopes: subsequences:create, subsequences:all, all:create, all:all

Path

idstring(uuid)required

Example: 123e4567-e89b-12d3-a456-426614174000

Bodyapplication/jsonrequired

parent_campaignstring(uuid)required

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

namestringrequired

Example: "My Duplicate Subsequence"

curl -i -X POST \
  https://api.instantly.ai/api/v2/subsequences/123e4567-e89b-12d3-a456-426614174000/duplicate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parent_campaign": "123e4567-e89b-12d3-a456-426614174000",
    "name": "My Duplicate Subsequence"
  }'

Responses

The requested Campaign Subsequence

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the subsequence

Example: "01959271-1f8d-77ea-896b-3e8ea0fce510"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the subsequence was created

Example: "2025-03-14T02:17:22.061Z"

parent_campaignstring(uuid)required

ID of the parent campaign

Example: "01959271-1f8d-77ea-896b-3e8fd1890713"

workspacestring(uuid)read-onlyrequired

ID of the workspace this subsequence belongs to

Example: "01959271-1f8d-77ea-896b-3e900d0c335f"

statusnumberread-onlyrequired

Status of the subsequence

Enum Value	Description
0	Draft - The subsequence is in draft mode and not yet active
1	Active - The subsequence is currently running
2	Paused - The subsequence has been manually paused
3	Completed - The subsequence has finished running
4	Running Subsequences - The subsequence has active child sequences
-99	Account Suspended - The subsequence is suspended due to account issues
-1	Accounts Unhealthy - The subsequence is paused due to unhealthy sending accounts
-2	Bounce Protection - The subsequence is paused due to high bounce rates

Example: 0

timestamp_leads_updatedstring(date-time)read-onlyrequired

Timestamp when the leads were last updated

Example: "2025-03-14T02:17:22.061Z"

namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

conditionsobjectrequired

Conditions that trigger the subsequence

conditions.crm_statusArray of numbers

Example: [1,2,3]

conditions.reply_containsstring

Example: "yes"

subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

subsequence_schedule.schedulesArray of objectsnon-emptyrequired

subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

subsequence_schedule.schedules[].timingobjectrequired

subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

subsequence_schedule.schedules[].daysobjectnon-emptyrequired

subsequence_schedule.schedules[].days.0boolean

Example: true

subsequence_schedule.schedules[].days.1boolean

Example: true

subsequence_schedule.schedules[].days.2boolean

Example: true

subsequence_schedule.schedules[].days.3boolean

Example: true

subsequence_schedule.schedules[].days.4boolean

Example: true

subsequence_schedule.schedules[].days.5boolean

Example: false

subsequence_schedule.schedules[].days.6boolean

Example: false

subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

subsequence_schedule.start_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

subsequence_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

sequences[].stepsArray of objectsrequired

sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

sequences[].steps[].variantsArray of objectsrequired

sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

Response

application/json

{
  "id": "01959271-1f8d-77ea-896b-3e8ea0fce510",
  "timestamp_created": "2025-03-14T02:17:22.061Z",
  "parent_campaign": "01959271-1f8d-77ea-896b-3e8fd1890713",
  "workspace": "01959271-1f8d-77ea-896b-3e900d0c335f",
  "status": 0,
  "timestamp_leads_updated": "2025-03-14T02:17:22.061Z",
  "name": "Follow-up sequence",
  "conditions": {
    "crm_status": [ … ],
    "reply_contains": "yes"
  },
  "subsequence_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ]
}

Pause a subsequence

Request

Pause a subsequence

Requires one of the following scopes: subsequences:update, subsequences:all, all:update, all:all

Path

idstring(uuid)required

Example: 123e4567-e89b-12d3-a456-426614174000

curl -i -X POST \
  https://api.instantly.ai/api/v2/subsequences/123e4567-e89b-12d3-a456-426614174000/pause \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign Subsequence

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the subsequence

Example: "01959271-1f8d-77ea-896b-3e8ea0fce510"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the subsequence was created

Example: "2025-03-14T02:17:22.061Z"

parent_campaignstring(uuid)required

ID of the parent campaign

Example: "01959271-1f8d-77ea-896b-3e8fd1890713"

workspacestring(uuid)read-onlyrequired

ID of the workspace this subsequence belongs to

Example: "01959271-1f8d-77ea-896b-3e900d0c335f"

statusnumberread-onlyrequired

Status of the subsequence

Enum Value	Description
0	Draft - The subsequence is in draft mode and not yet active
1	Active - The subsequence is currently running
2	Paused - The subsequence has been manually paused
3	Completed - The subsequence has finished running
4	Running Subsequences - The subsequence has active child sequences
-99	Account Suspended - The subsequence is suspended due to account issues
-1	Accounts Unhealthy - The subsequence is paused due to unhealthy sending accounts
-2	Bounce Protection - The subsequence is paused due to high bounce rates

Example: 0

timestamp_leads_updatedstring(date-time)read-onlyrequired

Timestamp when the leads were last updated

Example: "2025-03-14T02:17:22.061Z"

namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

conditionsobjectrequired

Conditions that trigger the subsequence

conditions.crm_statusArray of numbers

Example: [1,2,3]

conditions.reply_containsstring

Example: "yes"

subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

subsequence_schedule.schedulesArray of objectsnon-emptyrequired

subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

subsequence_schedule.schedules[].timingobjectrequired

subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

subsequence_schedule.schedules[].daysobjectnon-emptyrequired

subsequence_schedule.schedules[].days.0boolean

Example: true

subsequence_schedule.schedules[].days.1boolean

Example: true

subsequence_schedule.schedules[].days.2boolean

Example: true

subsequence_schedule.schedules[].days.3boolean

Example: true

subsequence_schedule.schedules[].days.4boolean

Example: true

subsequence_schedule.schedules[].days.5boolean

Example: false

subsequence_schedule.schedules[].days.6boolean

Example: false

subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

subsequence_schedule.start_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

subsequence_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

sequences[].stepsArray of objectsrequired

sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

sequences[].steps[].variantsArray of objectsrequired

sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

Response

application/json

{
  "id": "01959271-1f8d-77ea-896b-3e8ea0fce510",
  "timestamp_created": "2025-03-14T02:17:22.061Z",
  "parent_campaign": "01959271-1f8d-77ea-896b-3e8fd1890713",
  "workspace": "01959271-1f8d-77ea-896b-3e900d0c335f",
  "status": 0,
  "timestamp_leads_updated": "2025-03-14T02:17:22.061Z",
  "name": "Follow-up sequence",
  "conditions": {
    "crm_status": [ … ],
    "reply_contains": "yes"
  },
  "subsequence_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ]
}

Resume a paused subsequence

Request

Resume a paused subsequence

Requires one of the following scopes: subsequences:update, subsequences:all, all:update, all:all

Path

idstring(uuid)required

Example: 123e4567-e89b-12d3-a456-426614174000

curl -i -X POST \
  https://api.instantly.ai/api/v2/subsequences/123e4567-e89b-12d3-a456-426614174000/resume \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign Subsequence

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the subsequence

Example: "01959271-1f8d-77ea-896b-3e8ea0fce510"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the subsequence was created

Example: "2025-03-14T02:17:22.061Z"

parent_campaignstring(uuid)required

ID of the parent campaign

Example: "01959271-1f8d-77ea-896b-3e8fd1890713"

workspacestring(uuid)read-onlyrequired

ID of the workspace this subsequence belongs to

Example: "01959271-1f8d-77ea-896b-3e900d0c335f"

statusnumberread-onlyrequired

Status of the subsequence

Enum Value	Description
0	Draft - The subsequence is in draft mode and not yet active
1	Active - The subsequence is currently running
2	Paused - The subsequence has been manually paused
3	Completed - The subsequence has finished running
4	Running Subsequences - The subsequence has active child sequences
-99	Account Suspended - The subsequence is suspended due to account issues
-1	Accounts Unhealthy - The subsequence is paused due to unhealthy sending accounts
-2	Bounce Protection - The subsequence is paused due to high bounce rates

Example: 0

timestamp_leads_updatedstring(date-time)read-onlyrequired

Timestamp when the leads were last updated

Example: "2025-03-14T02:17:22.061Z"

namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

conditionsobjectrequired

Conditions that trigger the subsequence

conditions.crm_statusArray of numbers

Example: [1,2,3]

conditions.reply_containsstring

Example: "yes"

subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

subsequence_schedule.schedulesArray of objectsnon-emptyrequired

subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

subsequence_schedule.schedules[].timingobjectrequired

subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

subsequence_schedule.schedules[].daysobjectnon-emptyrequired

subsequence_schedule.schedules[].days.0boolean

Example: true

subsequence_schedule.schedules[].days.1boolean

Example: true

subsequence_schedule.schedules[].days.2boolean

Example: true

subsequence_schedule.schedules[].days.3boolean

Example: true

subsequence_schedule.schedules[].days.4boolean

Example: true

subsequence_schedule.schedules[].days.5boolean

Example: false

subsequence_schedule.schedules[].days.6boolean

Example: false

subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

subsequence_schedule.start_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

subsequence_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

sequences[].stepsArray of objectsrequired

sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

sequences[].steps[].variantsArray of objectsrequired

sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

Response

application/json

{
  "id": "01959271-1f8d-77ea-896b-3e8ea0fce510",
  "timestamp_created": "2025-03-14T02:17:22.061Z",
  "parent_campaign": "01959271-1f8d-77ea-896b-3e8fd1890713",
  "workspace": "01959271-1f8d-77ea-896b-3e900d0c335f",
  "status": 0,
  "timestamp_leads_updated": "2025-03-14T02:17:22.061Z",
  "name": "Follow-up sequence",
  "conditions": {
    "crm_status": [ … ],
    "reply_contains": "yes"
  },
  "subsequence_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ]
}

Get campaign subsequence

Request

Requires one of the following scopes: subsequences:read, subsequences:all, all:read, all:all

Path

idstringrequired

curl -i -X GET \
  'https://api.instantly.ai/api/v2/subsequences/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign Subsequence

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the subsequence

Example: "01959271-1f8d-77ea-896b-3e8ea0fce510"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the subsequence was created

Example: "2025-03-14T02:17:22.061Z"

parent_campaignstring(uuid)required

ID of the parent campaign

Example: "01959271-1f8d-77ea-896b-3e8fd1890713"

workspacestring(uuid)read-onlyrequired

ID of the workspace this subsequence belongs to

Example: "01959271-1f8d-77ea-896b-3e900d0c335f"

statusnumberread-onlyrequired

Status of the subsequence

Enum Value	Description
0	Draft - The subsequence is in draft mode and not yet active
1	Active - The subsequence is currently running
2	Paused - The subsequence has been manually paused
3	Completed - The subsequence has finished running
4	Running Subsequences - The subsequence has active child sequences
-99	Account Suspended - The subsequence is suspended due to account issues
-1	Accounts Unhealthy - The subsequence is paused due to unhealthy sending accounts
-2	Bounce Protection - The subsequence is paused due to high bounce rates

Example: 0

timestamp_leads_updatedstring(date-time)read-onlyrequired

Timestamp when the leads were last updated

Example: "2025-03-14T02:17:22.061Z"

namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

conditionsobjectrequired

Conditions that trigger the subsequence

conditions.crm_statusArray of numbers

Example: [1,2,3]

conditions.reply_containsstring

Example: "yes"

subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

subsequence_schedule.schedulesArray of objectsnon-emptyrequired

subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

subsequence_schedule.schedules[].timingobjectrequired

subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

subsequence_schedule.schedules[].daysobjectnon-emptyrequired

subsequence_schedule.schedules[].days.0boolean

Example: true

subsequence_schedule.schedules[].days.1boolean

Example: true

subsequence_schedule.schedules[].days.2boolean

Example: true

subsequence_schedule.schedules[].days.3boolean

Example: true

subsequence_schedule.schedules[].days.4boolean

Example: true

subsequence_schedule.schedules[].days.5boolean

Example: false

subsequence_schedule.schedules[].days.6boolean

Example: false

subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

subsequence_schedule.start_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

subsequence_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

sequences[].stepsArray of objectsrequired

sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

sequences[].steps[].variantsArray of objectsrequired

sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

Response

application/json

{
  "id": "01959271-1f8d-77ea-896b-3e8ea0fce510",
  "timestamp_created": "2025-03-14T02:17:22.061Z",
  "parent_campaign": "01959271-1f8d-77ea-896b-3e8fd1890713",
  "workspace": "01959271-1f8d-77ea-896b-3e900d0c335f",
  "status": 0,
  "timestamp_leads_updated": "2025-03-14T02:17:22.061Z",
  "name": "Follow-up sequence",
  "conditions": {
    "crm_status": [ … ],
    "reply_contains": "yes"
  },
  "subsequence_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ]
}

Patch campaign subsequence

Request

Requires one of the following scopes: subsequences:update, subsequences:all, all:update, all:all

Path

idstringrequired

Bodyapplication/json

non-empty

namestring

Name of the subsequence

Example: "Follow-up sequence"

conditionsobject

Conditions that trigger the subsequence

sequencesArray of objects

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

curl -i -X PATCH \
  'https://api.instantly.ai/api/v2/subsequences/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The updated Campaign Subsequence

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the subsequence

Example: "01959271-1f8d-77ea-896b-3e8ea0fce510"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the subsequence was created

Example: "2025-03-14T02:17:22.061Z"

parent_campaignstring(uuid)required

ID of the parent campaign

Example: "01959271-1f8d-77ea-896b-3e8fd1890713"

workspacestring(uuid)read-onlyrequired

ID of the workspace this subsequence belongs to

Example: "01959271-1f8d-77ea-896b-3e900d0c335f"

statusnumberread-onlyrequired

Status of the subsequence

Enum Value	Description
0	Draft - The subsequence is in draft mode and not yet active
1	Active - The subsequence is currently running
2	Paused - The subsequence has been manually paused
3	Completed - The subsequence has finished running
4	Running Subsequences - The subsequence has active child sequences
-99	Account Suspended - The subsequence is suspended due to account issues
-1	Accounts Unhealthy - The subsequence is paused due to unhealthy sending accounts
-2	Bounce Protection - The subsequence is paused due to high bounce rates

Example: 0

timestamp_leads_updatedstring(date-time)read-onlyrequired

Timestamp when the leads were last updated

Example: "2025-03-14T02:17:22.061Z"

namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

conditionsobjectrequired

Conditions that trigger the subsequence

conditions.crm_statusArray of numbers

Example: [1,2,3]

conditions.reply_containsstring

Example: "yes"

subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

subsequence_schedule.schedulesArray of objectsnon-emptyrequired

subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

subsequence_schedule.schedules[].timingobjectrequired

subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

subsequence_schedule.schedules[].daysobjectnon-emptyrequired

subsequence_schedule.schedules[].days.0boolean

Example: true

subsequence_schedule.schedules[].days.1boolean

Example: true

subsequence_schedule.schedules[].days.2boolean

Example: true

subsequence_schedule.schedules[].days.3boolean

Example: true

subsequence_schedule.schedules[].days.4boolean

Example: true

subsequence_schedule.schedules[].days.5boolean

Example: false

subsequence_schedule.schedules[].days.6boolean

Example: false

subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

subsequence_schedule.start_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

subsequence_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

sequences[].stepsArray of objectsrequired

sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

sequences[].steps[].variantsArray of objectsrequired

sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

Response

application/json

{
  "id": "01959271-1f8d-77ea-896b-3e8ea0fce510",
  "timestamp_created": "2025-03-14T02:17:22.061Z",
  "parent_campaign": "01959271-1f8d-77ea-896b-3e8fd1890713",
  "workspace": "01959271-1f8d-77ea-896b-3e900d0c335f",
  "status": 0,
  "timestamp_leads_updated": "2025-03-14T02:17:22.061Z",
  "name": "Follow-up sequence",
  "conditions": {
    "crm_status": [ … ],
    "reply_contains": "yes"
  },
  "subsequence_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ]
}

Delete campaign subsequence

Request

Requires one of the following scopes: subsequences:delete, subsequences:all, all:delete, all:all

Path

idstringrequired

curl -i -X DELETE \
  'https://api.instantly.ai/api/v2/subsequences/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The deleted Campaign Subsequence

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the subsequence

Example: "01959271-1f8d-77ea-896b-3e8ea0fce510"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the subsequence was created

Example: "2025-03-14T02:17:22.061Z"

parent_campaignstring(uuid)required

ID of the parent campaign

Example: "01959271-1f8d-77ea-896b-3e8fd1890713"

workspacestring(uuid)read-onlyrequired

ID of the workspace this subsequence belongs to

Example: "01959271-1f8d-77ea-896b-3e900d0c335f"

statusnumberread-onlyrequired

Status of the subsequence

Enum Value	Description
0	Draft - The subsequence is in draft mode and not yet active
1	Active - The subsequence is currently running
2	Paused - The subsequence has been manually paused
3	Completed - The subsequence has finished running
4	Running Subsequences - The subsequence has active child sequences
-99	Account Suspended - The subsequence is suspended due to account issues
-1	Accounts Unhealthy - The subsequence is paused due to unhealthy sending accounts
-2	Bounce Protection - The subsequence is paused due to high bounce rates

Example: 0

timestamp_leads_updatedstring(date-time)read-onlyrequired

Timestamp when the leads were last updated

Example: "2025-03-14T02:17:22.061Z"

namestringrequired

Name of the subsequence

Example: "Follow-up sequence"

conditionsobjectrequired

Conditions that trigger the subsequence

conditions.crm_statusArray of numbers

Example: [1,2,3]

conditions.reply_containsstring

Example: "yes"

subsequence_scheduleobjectrequired

Schedule configuration for the subsequence

subsequence_schedule.schedulesArray of objectsnon-emptyrequired

subsequence_schedule.schedules[].namestringrequired

Example: "My Schedule"

subsequence_schedule.schedules[].timingobjectrequired

subsequence_schedule.schedules[].timing.fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "09:00"

subsequence_schedule.schedules[].timing.tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required

Example: "17:00"

subsequence_schedule.schedules[].daysobjectnon-emptyrequired

subsequence_schedule.schedules[].days.0boolean

Example: true

subsequence_schedule.schedules[].days.1boolean

Example: true

subsequence_schedule.schedules[].days.2boolean

Example: true

subsequence_schedule.schedules[].days.3boolean

Example: true

subsequence_schedule.schedules[].days.4boolean

Example: true

subsequence_schedule.schedules[].days.5boolean

Example: false

subsequence_schedule.schedules[].days.6boolean

Example: false

subsequence_schedule.schedules[].timezonestringrequired

Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"

Example: "Etc/GMT+12"

subsequence_schedule.start_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

subsequence_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

sequencesArray of objectsrequired

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

sequences[].stepsArray of objectsrequired

sequences[].steps[].typestringrequired

Type of step. This has to be 'email' always - it's the only supported type for now

Value	Description
email	This steps represents an email

Example: "email"

sequences[].steps[].delaynumberrequired

The number of days to wait before sending the NEXT email

Example: 2

sequences[].steps[].variantsArray of objectsrequired

sequences[].steps[].variants[].subjectstringrequired

Example: "Hello {{firstName}}"

sequences[].steps[].variants[].bodystringrequired

Example: "Hey {{firstName}},\n\nI hope you are doing well."

Response

application/json

{
  "id": "01959271-1f8d-77ea-896b-3e8ea0fce510",
  "timestamp_created": "2025-03-14T02:17:22.061Z",
  "parent_campaign": "01959271-1f8d-77ea-896b-3e8fd1890713",
  "workspace": "01959271-1f8d-77ea-896b-3e900d0c335f",
  "status": 0,
  "timestamp_leads_updated": "2025-03-14T02:17:22.061Z",
  "name": "Follow-up sequence",
  "conditions": {
    "crm_status": [ … ],
    "reply_contains": "yes"
  },
  "subsequence_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ]
}

API Explorer (2.0.0)

Analytics

Account

Campaign

Email

Email Verification

Lead List

Inbox Placement Test

Inbox Placement Analytics

Inbox Placement Blacklist & SpamAssassin Report

API Key

Account Campaign Mapping

Lead

Background Job

Custom Tag

Block List Entry

Lead Label

Workspace

Workspace Group Member

Workspace Member

Campaign Subsequence

Campaign Subsequence

Create campaign subsequence

RequestExpand all

Responses

Was this helpful?

List campaign subsequence

Request

Responses

Was this helpful?

Duplicate a subsequence

Request

Responses

Was this helpful?

Pause a subsequence

Request

Responses

Was this helpful?

Resume a paused subsequence

Request

Responses

Was this helpful?

Get campaign subsequence

Request

Responses

Was this helpful?

Patch campaign subsequence

RequestExpand all

Responses

Was this helpful?

Delete campaign subsequence

Request

Responses

Was this helpful?

Schemas

Request

Request