Raw schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the sequence"
},
"senders": {
"type": "string",
"description": "Comma-separated sender UUIDs"
},
"lists": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Array of list UUIDs to include in the sequence"
},
"folder": {
"type": "string",
"description": "Optional general folder ID to organize the sequence. Must be a folder created without a type (i.e., not an email-sender folder)."
},
"starred": {
"type": "boolean",
"description": "Whether to star the sequence"
},
"launchTimingMode": {
"type": "string",
"enum": [
"now",
"schedule"
],
"description": "When to launch: 'now' (default, starts in ~5 mins) or 'schedule'"
},
"scheduledAt": {
"type": [
"number",
"string"
],
"description": "Launch time. UTC milliseconds OR an ISO 8601 datetime with timezone offset, e.g. '2026-07-08T16:30:00+05:30' for 4:30 PM IST. Required when launchTimingMode='schedule'."
},
"timezone": {
"type": "string",
"description": "IANA timezone for scheduled sending, e.g. 'Asia/Calcutta' or 'America/New_York'. Required when launchTimingMode='schedule'; otherwise it defaults to America/New_York."
},
"paused": {
"type": "boolean",
"default": true,
"description": "Whether to create the sequence in paused state. Default true (the API pauses new sequences when omitted). When false, the sequence launches and starts sending emails (in ~5 mins with launchTimingMode 'now', or at scheduledAt when 'schedule') and requires confirm: true as the account holder's explicit approval."
},
"confirm": {
"type": "boolean",
"description": "Required when paused is false โ confirms the account holder explicitly approved launching the sequence"
},
"delayEnabled": {
"type": "boolean",
"description": "Enable sending delay between emails"
},
"delayFrom": {
"type": "number",
"description": "Minimum delay in minutes"
},
"delayTo": {
"type": "number",
"description": "Maximum delay in minutes"
},
"stopWhenReplyRecieved": {
"type": "boolean",
"description": "Stop sequence when recipient replies"
},
"evergreen": {
"type": "boolean",
"description": "Enable evergreen sequence"
},
"bounceThreshold": {
"type": "number",
"description": "Bounce threshold before pausing"
},
"bouncePause": {
"type": "boolean",
"description": "Pause on bounce threshold reached"
},
"autoPause": {
"type": "boolean",
"description": "Enable auto-pause"
},
"autoTagReplies": {
"type": "boolean",
"description": "Auto-tag replies"
},
"emailSendingHours": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether sending is enabled on this day"
},
"name": {
"type": "string",
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"description": "Day of the week"
},
"fromTime": {
"type": "string",
"pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9]$",
"description": "Start time in 24-hour format (HH:MM)"
},
"toTime": {
"type": "string",
"pattern": "^([01]?[0-9]|2[0-3]):[0-5][0-9]$",
"description": "End time in 24-hour format (HH:MM)"
}
},
"required": [
"enabled",
"name",
"fromTime",
"toTime"
],
"additionalProperties": false
},
"description": "Custom email sending hours for each day of the week (Monday-Sunday). Default: weekdays 09:00-17:00 enabled, weekends disabled."
},
"steps": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "email"
},
"template_id": {
"type": "string",
"description": "Public template UUID for the email step"
},
"send_as": {
"type": "string",
"enum": [
"new",
"followup"
],
"description": "How to send this email: 'new' (default) starts a new thread; 'followup' replies in the lead's existing thread as 'Re: <original subject>'. Ignored on the first email step of the sequence, which always starts a new thread."
}
},
"required": [
"type",
"template_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "delay"
},
"days": {
"type": "number",
"description": "Number of days to wait before the next step"
}
},
"required": [
"type",
"days"
],
"additionalProperties": false
}
]
},
"minItems": 1,
"description": "Sequence steps. Required and non-empty. Each email step must be {type: 'email', template_id: 'public-template-uuid'} with optional send_as: 'new' | 'followup' (followup replies in the existing thread; ignored on the first email step, which always starts a new thread). Each delay step must be {type: 'delay', days: number}."
},
"sendToOnlyVerifiedEmail": {
"type": "boolean",
"description": "Only send to verified emails"
},
"validEmail": {
"type": "boolean",
"description": "Send to contacts with valid email status"
},
"riskyEmail": {
"type": "boolean",
"description": "Send to contacts with risky email status"
},
"invalidEmail": {
"type": "boolean",
"description": "Send to contacts with invalid email status"
},
"checkEmailOpen": {
"type": "boolean",
"description": "Check if recipient opened previous email"
},
"checkEmailClick": {
"type": "boolean",
"description": "Check if recipient clicked a link in previous email"
},
"checkEmailReply": {
"type": "boolean",
"description": "Check if recipient replied to previous email"
},
"checkEmailBeforeSending": {
"type": "boolean",
"description": "Verify email before sending. When enabled user must approve email before they can be sent"
},
"plainText": {
"type": "boolean",
"description": "Send as plain text email"
},
"auto_reply": {
"type": "boolean",
"description": "Enable auto-reply detection"
},
"matchProvider": {
"type": "boolean",
"description": "Match email provider when sending"
},
"skip_esg": {
"type": "boolean",
"description": "Skip ESG detection"
},
"stopWhenReplyRecievedWhen": {
"type": "string",
"enum": [
"contact",
"contact-with-same-domain"
],
"description": "When to stop sequence on reply: 'contact' = stop for this contact only, 'contact-with-same-domain' = stop for all contacts sharing the same domain"
},
"bcc": {
"type": "string",
"description": "BCC email address for all outgoing emails"
},
"workspace_id": {
"type": "string",
"description": "Workspace ID this action applies to. When omitted, the current or default workspace is used."
}
},
"required": [
"name",
"senders",
"lists",
"steps"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}