v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

CampaignSubsequence

Patch campaign subsequence

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

patch/api/v2/subsequences/{id}

Path parameters

idstring uuid required

Example:019f94cd-af2f-7f89-8066-33a644252753

The ID of the item to update

Request body

namestring

Name of the subsequence

daily_limit_mode'inherit' | 'custom' | 'unlimited'

Daily limit mode for the subsequence. "inherit" uses the parent campaign limit, "custom" uses a subsequence-specific limit, "unlimited" bypasses the campaign-level daily limit.

daily_limitnumber nullable

Custom daily limit for the subsequence. Only used when daily_limit_mode is "custom".

ignore_account_daily_limitboolean

When enabled, the subsequence will send even when sending accounts have reached their daily limit.

Example request

{
  "name": "Follow-up sequence",
  "daily_limit_mode": "inherit",
  "daily_limit": 50
}

Response

The updated Campaign Subsequence

idstring uuid required

Unique identifier for the subsequence

timestamp_createdstring date-time required

Timestamp when the subsequence was created

parent_campaignstring uuid required

ID of the parent campaign

workspacestring uuid required

ID of the workspace this subsequence belongs to

status-99 | -1 | -2 | 0 | 1 | 2 | 3 | 4 required

Status of the subsequence

timestamp_leads_updatedstring date-time required

Timestamp when the leads were last updated

namestring required

Name of the subsequence

daily_limit_mode'inherit' | 'custom' | 'unlimited'

Daily limit mode for the subsequence. "inherit" uses the parent campaign limit, "custom" uses a subsequence-specific limit, "unlimited" bypasses the campaign-level daily limit.

daily_limitnumber nullable

Custom daily limit for the subsequence. Only used when daily_limit_mode is "custom".

ignore_account_daily_limitboolean

When enabled, the subsequence will send even when sending accounts have reached their daily limit.

Example response

{
  "id": "019f94cd-8401-74c3-98cb-8d4953fe76bd",
  "timestamp_created": "2026-07-24T15:45:24.481Z",
  "parent_campaign": "019f94cd-8401-74c3-98cb-8d4a3ce0a67b",
  "workspace": "019f94cd-8401-74c3-98cb-8d4b8582121a",
  "timestamp_leads_updated": "2026-07-24T15:45:24.481Z",
  "name": "Follow-up sequence",
  "conditions": {
    "crm_status": [
      1
    ],
    "lead_activity": [
      4
    ],
    "reply_contains": "yes"
  },
  "subsequence_schedule": {
    "start_date": "2025-09-25",
    "end_date": "2025-09-25",
    "schedules": [
      {
        "name": "My Schedule",
        "timing": {
          "from": "09:00",
          "to": "17:00"
        },
        "days": {
          "0": true,
          "1": true,
          "2": true,
          "3": true,
          "4": true
        },
        "timezone": "Etc/GMT+12"
      }
    ]
  },
  "sequences": [
    {
      "steps": [
        {
          "type": "email",
          "delay": 2,
          "delay_unit": "days",
          "pre_delay": 2,
          "pre_delay_unit": "days",
          "variants": [
            {
              "subject": "Hello {{firstName}}",
              "body": "Hey {{firstName}},\n\nI hope you are doing well.",
              "v_disabled": true
            }
          ]
        }
      ]
    }
  ],
  "daily_limit_mode": "inherit",
  "daily_limit": 50
}