INinstantly
CampaignSubsequence

Patch campaign subsequence

Changed on

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

patch/api/v2/subsequences/{id}

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/subsequences/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6d-92c4-747c-bfc3-d1f5816346b8

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",
  "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}},<br/><br/>I hope you are doing well.",
              "v_disabled": true
            }
          ]
        }
      ]
    }
  ],
  "auto_variant_select": {
    "trigger": "click_rate"
  },
  "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": "01a19e6d-50f5-7741-a6d5-768515075d49",
  "timestamp_created": "2026-11-02T22:42:06.709Z",
  "parent_campaign": "01a19e6d-50f6-7e80-bf8a-f356baecaed9",
  "workspace": "01a19e6d-50f6-7e80-bf8a-f357e4b23540",
  "timestamp_leads_updated": "2026-11-02T22:42:06.710Z",
  "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}},<br/><br/>I hope you are doing well.",
              "v_disabled": true
            }
          ]
        }
      ]
    }
  ],
  "auto_variant_select": {
    "trigger": "click_rate"
  },
  "daily_limit_mode": "inherit",
  "daily_limit": 50
}

Changes

  • c781051105a8Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added 'contains' constraint to the //// response property for the status

    • info

      removed the -1.00 enum value from the // response property for the response status

    • info

      removed the -2.00 enum value from the // response property for the response status

    • info

      removed the -3.00 enum value from the // response property for the response status

    • info

      removed the -4.00 enum value from the // response property for the response status

    • info

      removed the 0.00 enum value from the // response property for the response status

    • info

      removed the 1.00 enum value from the // response property for the response status

    • info

      removed the 2.00 enum value from the // response property for the response status

    • info

      removed the 3.00 enum value from the // response property for the response status

    • info

      removed the 4.00 enum value from the // response property for the response status