HighLevel: Emails schemas

← Emails operations · All schemas

Create Email Campaign — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
editorContent	string	Optional	Optional initial editor content to persist immediately after campaign creation. Provide HTML or plain-text string content.
editorType	string	Required within parent	Editor type for the campaign content. Use `html` for code-editor campaigns or `text` for plain-text campaigns. One of: html, text
name	string	Required within parent	Campaign name
parentFolderId	string	Optional	Parent folder ID
templateId	string	Optional	Existing template ID to create the campaign from. Omit this field to create a blank campaign.
timeZone	string	Required within parent	Timezone for the campaign
userId	string	Required within parent	ID of the user performing this action
userName	string	Optional	Name of the user performing this action

Create Email Campaign — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaignCategory	string	Optional	Campaign category
campaignType	string	Optional	Campaign type
createdAt	string	Required within parent	Created at timestamp
deleted	boolean	Required within parent	Whether the campaign is deleted
id	string	Required within parent	Campaign ID
name	string	Optional	Campaign name
source	string	Optional	Source of the campaign
sourceId	string	Optional	Source ID of the campaign
status	string	Optional	Campaign status Known values: all, sent, failed, archived, draft, processing, scheduled, cancelled, paused
traceId	string	Optional	Trace ID of request
updatedAt	string	Required within parent	Last updated timestamp
variations	array	Optional	AB test variation identifiers (available only for AB test campaigns)
variations[]	Model	Each item	Expand Create Email Campaign — response body — variations item

Referenced models: Create Email Campaign — response body — variations item

Create Email Campaign — response body — variations item

Field	Type	Presence	Description and constraints
$	object	Root
isWinner	boolean	Required within parent	Whether this is the winning variation
sourceId	string	Required within parent	Variation source ID for stats lookup

Create a template folder — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	Folder name
userId	string	Optional	ID of the user performing this action

Create a template folder — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Optional	Created timestamp
id	string	Required within parent	Folder ID
name	string	Required within parent	Folder name
traceId	string	Optional	Trace ID of request
updatedAt	string	Optional	Updated timestamp

Create an email template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
editorContent	string	Optional	Optional initial editor content. Provide HTML or plain-text string content.
editorType	string	Required within parent	Editor type for the new template. Use `html` for code-editor templates or `text` for plain-text templates. One of: html, text
fromEmail	string	Optional	Sender email address
fromName	string	Optional	Sender name
name	string	Required within parent	Template name
parentFolderId	string	Optional	Parent folder ID
previewText	string	Optional	Preview text
subjectLine	string	Optional	Email subject line
userId	string	Optional	ID of the user performing this action

Create an email template — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Optional	Created timestamp
editorType	string	Required within parent	Editor type Known values: html, text
fromEmail	string	Optional	Sender email address
fromName	string	Optional	Sender name
id	string	Required within parent	Template ID
isPlainText	boolean	Required within parent	Whether template is plain text
name	string	Required within parent	Template name
parentFolderId	string	Optional	Parent folder ID
previewText	string	Optional	Preview text
previewUrl	string	Optional	Preview URL
subjectLine	string	Optional	Email subject line
traceId	string	Optional	Trace ID of request
updatedAt	string	Optional	Updated timestamp

Delete Campaign — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Whether the campaign was deleted successfully
traceId	string	Optional	Trace ID of the request

Delete a template — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Whether the template was deleted successfully
traceId	string	Optional	Trace ID of the request

Get Bulk Action Campaign by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Optional	Processing completion timestamp
createdAt	string	Required within parent	Created at timestamp
deleted	boolean	Required within parent	Whether the campaign is deleted
editorContentUrl	string	Optional	URL to fetch the rendered campaign content as HTML. Issue a GET against this URL to retrieve the body.
editorType	string	Optional	Editor type for this campaign Known values: html, builder, text
fromEmail	string	Optional	Sender email address
fromName	string	Optional	Sender name
id	string	Required within parent	Campaign ID
isPlainText	boolean	Optional	Whether the campaign uses plain text
name	string	Optional	Campaign name
previewText	string	Optional	Preview text
replyToAddress	string	Optional	Reply-to email address
scheduleType	string	Optional	Schedule type (NOW, SCHEDULED, or DRIP) Known values: NOW, SCHEDULED, DRIP
source	string	Optional	Source of the campaign
sourceId	string	Optional	Source ID of the campaign
status	string	Required within parent	Campaign status Known values: processing, scheduled, paused, complete, cancelled
subject	string	Optional	Email subject line
traceId	string	Optional	Trace ID of the request
updatedAt	string	Required within parent	Last updated timestamp

Get Campaign Statistics — response body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location ID
source	string	Required within parent	Source type Known values: email-campaigns, workflow-campaigns, bulk-actions
sourceId	string	Required within parent	Source ID
stats	JSON	Required within parent	Email performance metrics
stats (allOf 1)	Model	All variants apply	Expand Get Campaign Statistics — response body — stats accepted, bounce Rate, click Rate, clicked, complained, complaint Rate, delivered, failed, open Rate, opened, permanent Fail, rejected, replied, reply Rate, sent, temporary Fail, unsubscribe Rate, unsubscribed
subSourceId	string	Optional	Workflow action ID
traceId	string	Optional	Trace ID of the request

Referenced models: Get Campaign Statistics — response body — stats accepted, bounce Rate, click Rate, clicked, complained, complaint Rate, delivered, failed, open Rate, opened, permanent Fail, rejected, replied, reply Rate, sent, temporary Fail, unsubscribe Rate, unsubscribed

Get Campaign Statistics — response body — stats accepted, bounce Rate, click Rate, clicked, complained, complaint Rate, delivered, failed, open Rate, opened, permanent Fail, rejected, replied, reply Rate, sent, temporary Fail, unsubscribe Rate, unsubscribed

Field	Type	Presence	Description and constraints
$	object	Root
accepted	JSON	Required within parent
accepted (anyOf 1)	number	Alternative	Emails accepted by the mail server
accepted (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
bounceRate	JSON	Required within parent
bounceRate (anyOf 1)	number	Alternative	Bounce rate as percentage of sent
bounceRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
clickRate	JSON	Required within parent
clickRate (anyOf 1)	number	Alternative	Click rate as percentage of delivered
clickRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
clicked	JSON	Required within parent
clicked (anyOf 1)	number	Alternative	Links clicked
clicked (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
complained	JSON	Required within parent
complained (anyOf 1)	number	Alternative	Spam complaints
complained (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
complaintRate	JSON	Required within parent
complaintRate (anyOf 1)	number	Alternative	Complaint rate as percentage of delivered
complaintRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
delivered	JSON	Required within parent
delivered (anyOf 1)	number	Alternative	Emails delivered to inbox
delivered (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
failed	JSON	Required within parent
failed (anyOf 1)	number	Alternative	Failed emails
failed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
openRate	JSON	Required within parent
openRate (anyOf 1)	number	Alternative	Open rate as percentage of delivered
openRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
opened	JSON	Required within parent
opened (anyOf 1)	number	Alternative	Emails opened
opened (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
permanentFail	JSON	Required within parent
permanentFail (anyOf 1)	number	Alternative	Hard bounces
permanentFail (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rejected	JSON	Required within parent
rejected (anyOf 1)	number	Alternative	Rejected emails
rejected (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
replied	JSON	Required within parent
replied (anyOf 1)	number	Alternative	Replies received
replied (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
replyRate	JSON	Required within parent
replyRate (anyOf 1)	number	Alternative	Reply rate as percentage of delivered
replyRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sent	JSON	Required within parent
sent (anyOf 1)	number	Alternative	Total emails sent (delivered + accepted + bounced)
sent (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
temporaryFail	JSON	Required within parent
temporaryFail (anyOf 1)	number	Alternative	Soft bounces
temporaryFail (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unsubscribeRate	JSON	Required within parent
unsubscribeRate (anyOf 1)	number	Alternative	Unsubscribe rate as percentage of delivered
unsubscribeRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unsubscribed	JSON	Required within parent
unsubscribed (anyOf 1)	number	Alternative	Unsubscribes
unsubscribed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Email Campaign by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaignCategory	string	Optional	Campaign category
campaignType	string	Optional	Campaign delivery type
createdAt	string	Required within parent	Created at timestamp
deleted	boolean	Required within parent	Whether the campaign is deleted
editorContentUrl	string	Optional	URL to fetch the rendered campaign content as HTML. Issue a GET against this URL to retrieve the body.
editorType	string	Optional	Original editor type the campaign was created with Known values: html, builder, text
fromEmail	string	Optional	Sender email address
fromName	string	Optional	Sender name
id	string	Required within parent	Campaign ID
isPlainText	boolean	Optional	Whether the campaign uses plain text
name	string	Optional	Campaign name
previewText	string	Optional	Preview text
replyToAddress	string	Optional	Reply-to email address
source	string	Optional	Source of the campaign
sourceId	string	Optional	Source ID of the campaign
status	string	Optional	Campaign status Known values: all, sent, failed, archived, draft, processing, scheduled, cancelled, paused
subject	string	Optional	Email subject line
traceId	string	Optional	Trace ID of the request
updatedAt	string	Required within parent	Last updated timestamp
variations	array	Optional	AB test variation identifiers (available only for AB test campaigns)
variations[]	Model	Each item	Expand Create Email Campaign — response body — variations item

Referenced models: Create Email Campaign — response body — variations item

Get Email Template by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Optional	Created timestamp
deleted	boolean	Required within parent	Whether the template is deleted
editorContentUrl	string	Optional	URL to fetch the rendered template content as HTML. Issue a GET against this URL to retrieve the body.
editorType	string	Required within parent	Editor type Known values: html, builder, text
fromEmail	string	Optional	Sender email address
fromName	string	Optional	Sender name
id	string	Required within parent	Template ID
isPlainText	boolean	Required within parent	Whether template is plain text
name	string	Required within parent	Template name
parentFolderId	string	Optional	Parent folder ID
previewText	string	Optional	Preview text
subject	string	Optional	Email subject line
traceId	string	Optional	Trace ID of request
updatedAt	string	Optional	Updated timestamp

Get Workflow Campaign by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	Created at timestamp
deleted	boolean	Optional	Whether the campaign is deleted
id	string	Required within parent	Campaign ID
name	string	Optional	Campaign name
source	string	Optional	Source of the campaign
sourceId	string	Optional	Source ID of the campaign
status	string	Optional	Campaign status Known values: published, draft
subSources	array	Optional	Sub-sources (email-sending steps) within this workflow. Each entry's `id` can be passed as the `subSourceId` query parameter to the campaign stats endpoint to retrieve per-step stats.
subSources[]	Model	Each item	Expand Get Workflow Campaign by ID — response body — sub Sources item
traceId	string	Optional	Trace ID of the request
updatedAt	string	Required within parent	Updated at timestamp

Referenced models: Get Workflow Campaign by ID — response body — sub Sources item

Get Workflow Campaign by ID — response body — sub Sources item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Optional	Timestamp when this step was added to the workflow
editorContentUrl	string	Optional	URL to fetch the rendered step content as HTML. Issue a GET against this URL to retrieve the body.
editorType	string	Optional	Editor type for this step Known values: html, builder, text
fromEmail	string	Optional	Sender email address
fromName	string	Optional	Sender name
id	string	Required within parent	Sub-source identifier (workflow step). Pass this value as the `subSourceId` query parameter on the campaign stats endpoint to retrieve stats scoped to this step.
isPlainText	boolean	Optional	Whether this step uses plain text
name	string	Optional	Workflow step name
previewText	string	Optional	Preview text
subject	string	Optional	Email subject line
updatedAt	string	Optional	Timestamp when this step was last updated

Import an email template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
importProvider	string	Required within parent	Import provider (URL-based providers only) One of: mailchimp, active_campaign
importUrl	string	Required within parent	Public import URL
name	string	Optional	Template name
parentFolderId	string	Optional	Parent folder ID
userId	string	Optional	ID of the user performing this action

List Bulk Action Campaigns — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaigns	array	Required within parent	List of bulk action campaigns
campaigns[]	Model	Each item	Expand List Bulk Action Campaigns — response body — campaigns item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total count of bulk action campaigns
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Optional	Trace ID of the request

Referenced models: List Bulk Action Campaigns — response body — campaigns item

List Bulk Action Campaigns — response body — campaigns item

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Optional	Processing completion timestamp
createdAt	string	Required within parent	Created at timestamp
deleted	boolean	Required within parent	Whether the campaign is deleted
emailMetadata	JSON	Optional	Email metadata
emailMetadata (allOf 1)	Model	All variants apply	Expand List Bulk Action Campaigns — response body — campaigns item email Metadata from, name, subject, template Id
id	string	Required within parent	Campaign ID
name	string	Optional	Campaign name
scheduleType	string	Optional	Schedule type (NOW, SCHEDULED, or DRIP) Known values: NOW, SCHEDULED, DRIP
source	string	Optional	Source of the campaign
sourceId	string	Optional	Source ID of the campaign
status	string	Required within parent	Campaign status Known values: processing, scheduled, paused, complete, cancelled
updatedAt	string	Required within parent	Last updated timestamp

Referenced models: List Bulk Action Campaigns — response body — campaigns item email Metadata from, name, subject, template Id

List Bulk Action Campaigns — response body — campaigns item email Metadata from, name, subject, template Id

Field	Type	Presence	Description and constraints
$	object	Root
from	string	Optional	Sender (name and email)
name	string	Optional	Sender name
subject	string	Optional	Email subject line
templateId	string	Optional	Email template ID

List Email Campaigns — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaigns	array	Required within parent	List of email campaigns
campaigns[]	Model	Each item	Expand List Email Campaigns — response body — campaigns item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total count of email campaigns
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Optional	Trace ID of the request

Referenced models: List Email Campaigns — response body — campaigns item

List Email Campaigns — response body — campaigns item

Field	Type	Presence	Description and constraints
$	object	Root
campaignCategory	string	Optional	Campaign category
campaignType	string	Optional	Campaign type
createdAt	string	Required within parent	Created at timestamp
deleted	boolean	Required within parent	Whether the campaign is deleted
id	string	Required within parent	Campaign ID
name	string	Optional	Campaign name
source	string	Optional	Source of the campaign
sourceId	string	Optional	Source ID of the campaign
status	string	Optional	Campaign status Known values: all, sent, failed, archived, draft, processing, scheduled, cancelled, paused
updatedAt	string	Required within parent	Last updated timestamp
variations	array	Optional	AB test variation identifiers (available only for AB test campaigns)
variations[]	Model	Each item	Expand Create Email Campaign — response body — variations item

Referenced models: Create Email Campaign — response body — variations item

List Workflow Campaigns — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaigns	array	Required within parent	List of workflow campaigns
campaigns[]	Model	Each item	Expand List Workflow Campaigns — response body — campaigns item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total count of campaigns
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Optional	Trace ID of the request

Referenced models: List Workflow Campaigns — response body — campaigns item

List Workflow Campaigns — response body — campaigns item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	Created at timestamp
deleted	boolean	Optional	Whether the campaign is deleted
id	string	Required within parent	Campaign ID
name	string	Optional	Campaign name
source	string	Optional	Source of the campaign
sourceId	string	Optional	Source ID of the campaign
status	string	Optional	Campaign status Known values: published, draft
updatedAt	string	Required within parent	Updated at timestamp

List templates — emails list Email Templates — response body

Field	Type	Presence	Description and constraints
$	object	Root
items	array	Required within parent	List of template and folder resources
items[]	Model	Each item	Expand List templates — emails list Email Templates — response body — items item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total count of templates and folders
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Optional	Trace ID of the request

Referenced models: List templates — emails list Email Templates — response body — items item

List templates — emails list Email Templates — response body — items item

Field	Type	Presence	Description and constraints
$	object	Root
childCount	JSON	Optional
childCount (anyOf 1)	number	Alternative	Children count for folder resources
childCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Optional	Created timestamp
editorType	string	Optional	Editor type for template resources Known values: html, builder, text
hasChildren	boolean	Optional	Whether folder has child resources
id	string	Required within parent	Resource ID
isPlainText	boolean	Optional	Whether template is plain text
name	string	Required within parent	Resource name
parentFolderId	string	Optional	Parent folder ID
previewUrl	string	Optional	Preview URL
type	string	Required within parent	Resource type Known values: template, folder
updatedAt	string	Optional	Last updated timestamp

Schedule Campaign — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
abTestConfig	JSON	Optional	A/B test configuration. Can be combined with any scheduleType except rss.
abTestConfig (allOf 1)	Model	All variants apply	Expand Schedule Campaign — request body — body / abTestConfig / testType: email Content, subject Line, winning Criteria: open Rate, click Rate
emailMeta	JSON	Required within parent	Email subject, sender, and content metadata
emailMeta (allOf 1)	Model	All variants apply	Expand Schedule Campaign — request body — body email Meta attachments, from Email, from Name, preview Text, reply To Address, subject
recipients	JSON	Required within parent	Who receives the email. Must provide either contactIds or filter.
recipients (allOf 1)	Model	All variants apply	Expand Schedule Campaign — request body — body / recipients / type: contact, tag, segment
rssConfig	JSON	Optional	RSS feed configuration. Required when scheduleType is rss.
rssConfig (allOf 1)	Model	All variants apply	Expand Schedule Campaign — request body — body / rssConfig / repeatAfter: every day, every week, every month, start At Day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
scheduleConfig	JSON	Optional	Schedule configuration for immediate, scheduled, batch, and smart_send types. Required when scheduleType is not rss.
scheduleConfig (allOf 1)	Model	All variants apply	Expand Schedule Campaign — request body — body schedule Config batch, email Preference Id, resend, send At, tracking
scheduleType	string	Required within parent	How to schedule the campaign One of: immediate, scheduled, batch, rss, smart_send
sendDays	array	Optional	Days of the week to allow sending. Used for batch and RSS scheduleTypes.
sendDays[]	string	Each item	One of: Mon, Tue, Wed, Thu, Fri, Sat, Sun
timeZone	string	Required within parent	IANA timezone
userId	string	Required within parent	ID of the user performing this action
userName	string	Optional	Name of the user performing this action

Referenced models: Schedule Campaign — request body — body / abTestConfig / testType: email Content, subject Line, winning Criteria: open Rate, click Rate, Schedule Campaign — request body — body email Meta attachments, from Email, from Name, preview Text, reply To Address, subject, Schedule Campaign — request body — body / recipients / type: contact, tag, segment, Schedule Campaign — request body — body / rssConfig / repeatAfter: every day, every week, every month, start At Day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Schedule Campaign — request body — body schedule Config batch, email Preference Id, resend, send At, tracking

Schedule Campaign — request body — body / abTestConfig / testType: email Content, subject Line, winning Criteria: open Rate, click Rate

Field	Type	Presence	Description and constraints
$	object	Root
testDuration	number	Required within parent	Seconds to run the test before picking a winner
testSize	number	Required within parent	Percentage of contacts in the test group (0-100)
testType	string	Required within parent	What is being tested One of: emailContent, subjectLine
variationCount	number	Required within parent	Number of variations
variations	array	Required within parent	A/B test variations
variations[]	Model	Each item	Expand Schedule Campaign — request body — body / abTestConfig / testType: email Content, subject Line, winning Criteria: open Rate, click Rate variations item
winningCriteria	string	Required within parent	How to pick the winner One of: openRate, clickRate

Referenced models: Schedule Campaign — request body — body / abTestConfig / testType: email Content, subject Line, winning Criteria: open Rate, click Rate variations item

Schedule Campaign — request body — body / abTestConfig / testType: email Content, subject Line, winning Criteria: open Rate, click Rate variations item

Field	Type	Presence	Description and constraints
$	object	Root
documentId	string	Optional	Template/document ID for this variation
subject	string	Optional	Subject line for this variation

Schedule Campaign — request body — body / recipients / type: contact, tag, segment

Field	Type	Presence	Description and constraints
$	object	Root
contactIds	array	Optional	Contact IDs to send to. Required when type is contact.
contactIds[]	string	Each item
freezeList	boolean	Optional	Freeze the contact list at schedule time — new matching contacts will not be added later Default: true
segment	string	Optional	Segment type for pre-built segments. Required when type is segment. One of: engaged_last_7_days, engaged_last_30_days, engaged_last_60_days, engaged_last_5_campaigns, unengaged_last_5_campaigns
tagIds	array	Optional	Tag IDs to filter recipients by. Required when type is tag.
tagIds[]	string	Each item
type	string	Required within parent	Recipient selection type One of: contact, tag, segment

Schedule Campaign — request body — body / rssConfig / repeatAfter: every day, every week, every month, start At Day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

Field	Type	Presence	Description and constraints
$	object	Root
firstExecutionDate	string	Optional	Override first execution date/time
name	string	Required within parent	RSS schedule name
repeatAfter	string	Required within parent	How often to check the feed One of: every_day, every_week, every_month
repeatAfterTime	string	Required within parent	Time of day to execute
rssFeedLimit	number	Optional	Max number of RSS items per email
rssFeedURL	string	Required within parent	RSS feed URL
startAtDay	string	Optional	Day of week for weekly RSS One of: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
startAtMonthDay	string	Optional	Day of month for monthly RSS

Schedule Campaign — request body — body / scheduleConfig / batch, emailPreferenceId, resend, sendAt, tracking / batch / intervalUnit: minutes, hours, days

Field	Type	Presence	Description and constraints
$	object	Root
batchSize	number	Required within parent	Number of contacts to process per batch
interval	number	Required within parent	Delay between batches
intervalUnit	string	Required within parent	Unit for the interval One of: minutes, hours, days
skipDays	array	Optional	Days to skip sending
skipDays[]	string	Each item	One of: Mon, Tue, Wed, Thu, Fri, Sat, Sun
windowEnd	string	Optional	Latest time to send batches
windowStart	string	Optional	Earliest time to send batches

Schedule Campaign — request body — body email Meta attachments, from Email, from Name, preview Text, reply To Address, subject

Field	Type	Presence	Description and constraints
$	object	Root
attachments	array	Optional	Attachment download URLs
attachments[]	string	Each item
fromEmail	string	Required within parent	Sender email address
fromName	string	Required within parent	Sender display name
previewText	string	Optional	Preview text shown in inbox after subject
replyToAddress	string	Optional	Reply-to email address
subject	string	Required within parent	Email subject line

Schedule Campaign — request body — body schedule Config batch, email Preference Id, resend, send At, tracking

Field	Type	Presence	Description and constraints
$	object	Root
batch	JSON	Optional	Batch/drip configuration. Required when scheduleType is batch. Ignored otherwise.
batch (allOf 1)	Model	All variants apply	Expand Schedule Campaign — request body — body / scheduleConfig / batch, emailPreferenceId, resend, sendAt, tracking / batch / intervalUnit: minutes, hours, days
emailPreferenceId	string	Optional	Email preference type ID for categorizing this campaign
resend	JSON	Optional	Auto-resend to contacts who did not open
resend (allOf 1)	Model	All variants apply	Expand Schedule Campaign — request body — body schedule Config batch, email Preference Id, resend, send At, tracking resend enabled, subject, wait Hours
sendAt	string	Optional	Date/time to send. Required for scheduled, batch, and smart_send. Ignored for immediate.
tracking	JSON	Optional	Click and UTM tracking options
tracking (allOf 1)	Model	All variants apply	Expand Schedule Campaign — request body — body schedule Config batch, email Preference Id, resend, send At, tracking tracking click Tracking, utm Tracking

Referenced models: Schedule Campaign — request body — body / scheduleConfig / batch, emailPreferenceId, resend, sendAt, tracking / batch / intervalUnit: minutes, hours, days, Schedule Campaign — request body — body schedule Config batch, email Preference Id, resend, send At, tracking resend enabled, subject, wait Hours, Schedule Campaign — request body — body schedule Config batch, email Preference Id, resend, send At, tracking tracking click Tracking, utm Tracking

Schedule Campaign — request body — body schedule Config batch, email Preference Id, resend, send At, tracking resend enabled, subject, wait Hours

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Optional	Enable resend to contacts who did not open
subject	string	Optional	Override subject line for the resend email
waitHours	number	Optional	Hours to wait before resending. Required when enabled is true.

Schedule Campaign — request body — body schedule Config batch, email Preference Id, resend, send At, tracking tracking click Tracking, utm Tracking

Field	Type	Presence	Description and constraints
$	object	Root
clickTracking	boolean	Optional	Enable click tracking on links
utmTracking	boolean	Optional	Enable UTM parameters on links

Schedule Campaign — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaignId	string	Required within parent	Campaign ID
sourceId	JSON	Required within parent
sourceId (anyOf 1)	string	Alternative	Source ID for fetching campaign statistics
sourceId (anyOf 2)	null	Alternative
traceId	string	Optional	Trace ID of the request

Update Email Campaign — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
editorContent	string	Optional	Editor content to update. Required only when updating campaign content, and must be provided together with editorType. Provide HTML or plain-text string content.
editorType	string	Optional	Editor type for campaign content. Required only when updating campaign content, and must be provided together with editorContent. One of: html, text
name	string	Optional	Campaign name
userId	string	Optional	ID of the user performing this action

Update an email template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	Whether template is archived
editorContent	string	Optional	Editor content to update. Required only when updating template content, and must be provided together with editorType. Provide HTML or plain-text string content.
editorType	string	Optional	Type of editor content. Required only when updating template content, and must be provided together with editorContent. One of: html, text
fromEmail	string	Optional	Sender email address
fromName	string	Optional	Sender name
name	string	Optional	Template name
parentFolderId	string	Optional	Parent folder ID. Pass `null` to move template to the root level.
previewText	string	Optional	Preview text
subjectLine	string	Optional	Email subject line
userId	string	Optional	ID of the user performing this action

Update an email template — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	Whether template is archived
createdAt	string	Optional	Created timestamp
editorType	string	Optional	Template type Known values: html, text
fromEmail	string	Required within parent	Sender email address
fromName	string	Required within parent	Sender name
id	string	Required within parent	Template ID
isPlainText	boolean	Optional	Whether template is plain text
name	string	Required within parent	Template name
parentFolderId	string	Optional	Parent folder ID
previewText	string	Required within parent	Preview text
previewUrl	string	Required within parent	Preview URL
subjectLine	string	Required within parent	Email subject line
traceId	string	Optional	Trace ID of request
updatedAt	string	Optional	Last updated timestamp