This schema describes objects returned by the Campaign Subsequence endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the subsequence (read-only) |
timestamp_created | string (date-time) | Yes | Timestamp when the subsequence was created (read-only) |
parent_campaign | string (uuid) | Yes | ID of the parent campaign |
workspace | string (uuid) | Yes | ID of the workspace this subsequence belongs to (read-only) |
status | number | Yes | Status of the subsequence. Possible values: -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), 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) (read-only) |
timestamp_leads_updated | string (date-time) | Yes | Timestamp when the leads were last updated (read-only) |
name | string | Yes | Name of the subsequence |
conditions | object | Yes | Conditions that trigger the subsequence |
conditions.crm_status | array | No | Lead CRM statuses that trigger the subsequence. |
conditions.lead_activity | array | No | Lead activities that trigger the subsequence. |
conditions.reply_contains | string | No | |
subsequence_schedule | object | Yes | Schedule configuration for the subsequence |
subsequence_schedule.start_date | string (date), nullable | No | Start date in YYYY-MM-DD format. Uses the campaign’s timezone. |
subsequence_schedule.end_date | string (date), nullable | No | End date in YYYY-MM-DD format. Uses the campaign’s timezone. |
subsequence_schedule.schedules | array | No | |
subsequence_schedule.schedules[].name | string | No | |
subsequence_schedule.schedules[].timing | object | No | |
subsequence_schedule.schedules[].timing.from | string | No | |
subsequence_schedule.schedules[].timing.to | string | No | |
subsequence_schedule.schedules[].days | object | No | |
subsequence_schedule.schedules[].days.0 | boolean | No | |
subsequence_schedule.schedules[].days.1 | boolean | No | |
subsequence_schedule.schedules[].days.2 | boolean | No | |
subsequence_schedule.schedules[].days.3 | boolean | No | |
subsequence_schedule.schedules[].days.4 | boolean | No | |
subsequence_schedule.schedules[].days.5 | boolean | No | |
subsequence_schedule.schedules[].days.6 | boolean | No | |
subsequence_schedule.schedules[].timezone | string | No | Possible values: Etc/GMT+12, Etc/GMT+11, Etc/GMT+10, America/Anchorage, America/Dawson, America/Creston, America/Chihuahua, America/Boise, America/Belize, America/Chicago, America/Bahia_Banderas, America/Regina, America/Bogota, America/Detroit, America/Indiana/Marengo, America/Caracas, America/Asuncion, America/Glace_Bay, America/Campo_Grande, America/Anguilla, America/Santiago, America/St_Johns, America/Sao_Paulo, America/Argentina/La_Rioja, America/Araguaina, America/Godthab, America/Montevideo, America/Bahia, America/Noronha, America/Scoresbysund, Atlantic/Cape_Verde, Africa/Casablanca, America/Danmarkshavn, Europe/Isle_of_Man, Atlantic/Canary, Africa/Abidjan, Arctic/Longyearbyen, Europe/Belgrade, Africa/Ceuta, Europe/Sarajevo, Africa/Algiers, Africa/Windhoek, Asia/Nicosia, Asia/Beirut, Africa/Cairo, Asia/Damascus, Europe/Bucharest, Africa/Blantyre, Europe/Helsinki, Europe/Istanbul, Asia/Jerusalem, Africa/Tripoli, Asia/Amman, Asia/Baghdad, Europe/Kaliningrad, Asia/Aden, Africa/Addis_Ababa, Europe/Kirov, Europe/Astrakhan, Asia/Tehran, Asia/Dubai, Asia/Baku, Indian/Mahe, Asia/Tbilisi, Asia/Yerevan, Asia/Kabul, Antarctica/Mawson, Asia/Yekaterinburg, Asia/Karachi, Asia/Kolkata, Asia/Colombo, Asia/Kathmandu, Antarctica/Vostok, Asia/Dhaka, Asia/Rangoon, Antarctica/Davis, Asia/Novokuznetsk, Asia/Hong_Kong, Asia/Krasnoyarsk, Asia/Brunei, Australia/Perth, Asia/Taipei, Asia/Choibalsan, Asia/Irkutsk, Asia/Dili, Asia/Pyongyang, Australia/Adelaide, Australia/Darwin, Australia/Brisbane, Australia/Melbourne, Antarctica/DumontDUrville, Australia/Currie, Asia/Chita, Antarctica/Macquarie, Asia/Sakhalin, Pacific/Auckland, Etc/GMT-12, Pacific/Fiji, Asia/Anadyr, Asia/Kamchatka, Etc/GMT-13, Pacific/Apia |
sequences | array | Yes | 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[].steps | array | No | |
sequences[].steps[].type | string | No | Type of step. This has to be ‘email’ always - it’s the only supported type for now. Possible values: email (This steps represents an email) |
sequences[].steps[].delay | number | No | The delay value before sending the NEXT email. The unit is determined by the delay_unit field (defaults to days). |
sequences[].steps[].delay_unit | string | No | The unit of time for the delay value (minutes, hours, or days). Defaults to days for backward compatibility.. Possible values: minutes, hours, days |
sequences[].steps[].pre_delay | number | No | The delay value before sending the FIRST email in a subsequence. Only applicable to subsequences - this field is ignored for regular campaigns. The unit is determined by the pre_delay_unit field (defaults to days). |
sequences[].steps[].pre_delay_unit | string | No | The unit of time for the pre_delay value (minutes, hours, or days). Only applicable to subsequences - this field is ignored for regular campaigns. Defaults to days for backward compatibility.. Possible values: minutes, hours, days |
sequences[].steps[].variants | array | No | |
sequences[].steps[].variants[].subject | string | No | |
sequences[].steps[].variants[].body | string | No | |
sequences[].steps[].variants[].v_disabled | boolean | No | Whether this variant is disabled. By default, all the variants are enabled. Please set this to true if you want to disable this variant |