HubSpot: Marketing emails schemas

← Marketing emails operations · All schemas

Clone a marketing email — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
cloneName	string	Optional	The name to assign to the cloned email.
id	string	Required within parent	The email ID.
language	string	Optional	The language code for the cloned email, such as 'en' for English.

Create Email — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
activeDomain	string	Optional	The active domain of the email.
archived	boolean	Optional	Determines if the email is archived or not.
businessUnitId	integer	Optional	The ID of the business unit associated with the email. Format: int64
campaign	string	Optional	The ID of the campaign this email is associated to.
content	Model	Optional	Expand Create Email — request body — body content
feedbackSurveyId	string	Optional	The ID of the feedback survey linked to the email.
folderIdV2	integer	Optional	The ID of the folder where the email will be stored. Format: int64
from	Model	Optional	Expand Create Email — response body — from
jitterSendTime	boolean	Optional	Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.
language	string	Optional	The language code for the email, such as 'en' for English. One of: aa, ab, ae, af, af-na, af-za, agq, agq-cm, ak, ak-gh, am, am-et, an, ann, ann-ng, ar, ar-001, ar-ae, ar-bh, ar-dj, ar-dz, ar-eg, ar-eh, ar-er, ar-il, ar-iq, ar-jo, ar-km, ar-kw, ar-lb, ar-ly, ar-ma, ar-mr, ar-om, ar-ps, ar-qa, ar-sa, ar-sd, ar-so, ar-ss, ar-sy, ar-td, ar-tn, ar-ye, as, as-in, asa, asa-tz, ast, ast-es, av, ay, az, az-az, ba, bal, bal-pk, bas, bas-cm, be, be-by, bem, bem-zm, bez, bez-tz, bg, bg-bg, bgc, bgc-in, bho, bho-in, bi, blo, blo-bj, bm, bm-ml, bn, bn-bd, bn-in, bo, bo-cn, bo-in, br, br-fr, brx, brx-in, bs, bs-ba, ca, ca-ad, ca-es, ca-fr, ca-it, ccp, ccp-bd, ccp-in, ce, ce-ru, ceb, ceb-ph, cgg, cgg-ug, ch, chr, chr-us, ckb, ckb-iq, ckb-ir, co, cr, cs, cs-cz, csw, csw-ca, cu, cu-ru, cv, cv-ru, cy, cy-gb, da, da-dk, da-gl, dav, dav-ke, de, de-at, de-be, de-ch, de-de, de-gr, de-it, de-li, de-lu, dje, dje-ne, doi, doi-in, dsb, dsb-de, dua, dua-cm, dv, dyo, dyo-sn, dz, dz-bt, ebu, ebu-ke, ee, ee-gh, ee-tg, el, el-cy, el-gr, en, en-001, en-150, en-ae, en-ag, en-ai, en-as, en-at, en-au, en-bb, en-be, en-bi, en-bm, en-bs, en-bw, en-bz, en-ca, en-cc, en-ch, en-ck, en-cm, en-cn, en-cx, en-cy, en-cz, en-de, en-dg, en-dk, en-dm, en-ee, en-eg, en-er, en-es, en-fi, en-fj, en-fk, en-fm, en-fr, en-gb, en-gd, en-gg, en-gh, en-gi, en-gm, en-gs, en-gu, en-gy, en-hk, en-hu, en-id, en-ie, en-il, en-im, en-in, en-io, en-it, en-je, en-jm, en-ke, en-ki, en-kn, en-ky, en-lc, en-lr, en-ls, en-lu, en-mg, en-mh, en-mo, en-mp, en-ms, en-mt, en-mu, en-mv, en-mw, en-mx, en-my, en-na, en-nf, en-ng, en-nl, en-no, en-nr, en-nu, en-nz, en-pg, en-ph, en-pk, en-pl, en-pn, en-pr, en-pt, en-pw, en-ro, en-rw, en-sb, en-sc, en-sd, en-se, en-sg, en-sh, en-si, en-sk, en-sl, en-ss, en-sx, en-sz, en-tc, en-th, en-tk, en-tn, en-to, en-tt, en-tv, en-tz, en-ug, en-um, en-us, en-vc, en-vg, en-vi, en-vn, en-vu, en-ws, en-za, en-zm, en-zw, eo, eo-001, es, es-419, es-ar, es-bo, es-br, es-bz, es-cl, es-co, es-cr, es-cu, es-do, es-ea, es-ec, es-es, es-gq, es-gt, es-hn, es-ic, es-mx, es-ni, es-pa, es-pe, es-ph, es-pr, es-py, es-sv, es-us, es-uy, es-ve, et, et-ee, eu, eu-es, ewo, ewo-cm, fa, fa-af, fa-ir, ff, ff-bf, ff-cm, ff-gh, ff-gm, ff-gn, ff-gw, ff-lr, ff-mr, ff-ne, ff-ng, ff-sl, ff-sn, fi, fi-fi, fil, fil-ph, fj, fo, fo-dk, fo-fo, fr, fr-be, fr-bf, fr-bi, fr-bj, fr-bl, fr-ca, fr-cd, fr-cf, fr-cg, fr-ch, fr-ci, fr-cm, fr-dj, fr-dz, fr-fr, fr-ga, fr-gf, fr-gn, fr-gp, fr-gq, fr-ht, fr-km, fr-lu, fr-ma, fr-mc, fr-mf, fr-mg, fr-ml, fr-mq, fr-mr, fr-mu, fr-nc, fr-ne, fr-pf, fr-pm, fr-re, fr-rw, fr-sc, fr-sn, fr-sy, fr-td, fr-tg, fr-tn, fr-vu, fr-wf, fr-yt, frr, frr-de, fur, fur-it, fy, fy-nl, ga, ga-gb, ga-ie, gaa, gaa-gh, gd, gd-gb, gl, gl-es, gn, gsw, gsw-ch, gsw-fr, gsw-li, gu, gu-in, guz, guz-ke, gv, gv-im, ha, ha-gh, ha-ne, ha-ng, haw, haw-us, he, he-il, hi, hi-in, hmn, ho, hr, hr-ba, hr-hr, hsb, hsb-de, ht, ht-ht, hu, hu-hu, hy, hy-am, hz, ia, ia-001, id, id-id, ie, ie-ee, ig, ig-ng, ii, ii-cn, ik, io, is, is-is, it, it-ch, it-it, it-sm, it-va, iu, ja, ja-jp, jgo, jgo-cm, jmc, jmc-tz, jv, jv-id, ka, ka-ge, kab, kab-dz, kam, kam-ke, kar, kde, kde-tz, kea, kea-cv, kg, kgp, kgp-br, kh, khq, khq-ml, ki, ki-ke, kj, kk, kk-kz, kkj, kkj-cm, kl, kl-gl, kln, kln-ke, km, km-kh, kn, kn-in, ko, ko-cn, ko-kp, ko-kr, kok, kok-in, kr, ks, ks-in, ksb, ksb-tz, ksf, ksf-cm, ksh, ksh-de, ku, ku-tr, kv, kw, kw-gb, kxv, kxv-in, ky, ky-kg, la, lag, lag-tz, lb, lb-lu, lg, lg-ug, li, lij, lij-it, lkt, lkt-us, lmo, lmo-it, ln, ln-ao, ln-cd, ln-cf, ln-cg, lo, lo-la, lrc, lrc-iq, lrc-ir, lt, lt-lt, lu, lu-cd, luo, luo-ke, luy, luy-ke, lv, lv-lv, mai, mai-in, mas, mas-ke, mas-tz, mdf, mdf-ru, mer, mer-ke, mfe, mfe-mu, mg, mg-mg, mgh, mgh-mz, mgo, mgo-cm, mh, mi, mi-nz, mk, mk-mk, ml, ml-in, mn, mn-mn, mni, mni-in, mr, mr-in, ms, ms-bn, ms-id, ms-my, ms-sg, mt, mt-mt, mua, mua-cm, my, my-mm, mzn, mzn-ir, na, naq, naq-na, nb, nb-no, nb-sj, nd, nd-zw, nds, nds-de, nds-nl, ne, ne-in, ne-np, ng, nl, nl-aw, nl-be, nl-bq, nl-ch, nl-cw, nl-lu, nl-nl, nl-sr, nl-sx, nmg, nmg-cm, nn, nn-no, nnh, nnh-cm, no, no-no, nqo, nqo-gn, nr, nso, nso-za, nus, nus-ss, nv, ny, nyn, nyn-ug, oc, oc-es, oc-fr, oj, om, om-et, om-ke, or, or-in, os, os-ge, os-ru, pa, pa-in, pa-pk, pcm, pcm-ng, pi, pis, pis-sb, pl, pl-pl, prg, prg-001, ps, ps-af, ps-pk, pt, pt-ao, pt-br, pt-ch, pt-cv, pt-gq, pt-gw, pt-lu, pt-mo, pt-mz, pt-pt, pt-st, pt-tl, qu, qu-bo, qu-ec, qu-pe, raj, raj-in, rm, rm-ch, rn, rn-bi, ro, ro-md, ro-ro, rof, rof-tz, ru, ru-by, ru-kg, ru-kz, ru-md, ru-ru, ru-ua, rw, rw-rw, rwk, rwk-tz, sa, sa-in, sah, sah-ru, saq, saq-ke, sat, sat-in, sbp, sbp-tz, sc, sc-it, sd, sd-in, sd-pk, se, se-fi, se-no, se-se, seh, seh-mz, ses, ses-ml, sg, sg-cf, shi, shi-ma, si, si-lk, sk, sk-sk, sl, sl-si, sm, smn, smn-fi, sms, sms-fi, sn, sn-zw, so, so-dj, so-et, so-ke, so-so, sq, sq-al, sq-mk, sq-xk, sr, sr-ba, sr-cs, sr-me, sr-rs, sr-xk, ss, st, st-ls, st-za, su, su-id, sv, sv-ax, sv-fi, sv-se, sw, sw-cd, sw-ke, sw-tz, sw-ug, sy, syr, syr-iq, syr-sy, szl, szl-pl, ta, ta-in, ta-lk, ta-my, ta-sg, te, te-in, teo, teo-ke, teo-ug, tg, tg-tj, th, th-th, ti, ti-er, ti-et, tk, tk-tm, tl, tn, tn-bw, tn-za, to, to-to, tok, tok-001, tr, tr-cy, tr-tr, ts, tt, tt-ru, tw, twq, twq-ne, ty, tzm, tzm-ma, ug, ug-cn, uk, uk-ua, ur, ur-in, ur-pk, uz, uz-af, uz-uz, vai, vai-lr, ve, vec, vec-it, vi, vi-vn, vmw, vmw-mz, vo, vo-001, vun, vun-tz, wa, wae, wae-ch, wo, wo-sn, xh, xh-za, xnr, xnr-in, xog, xog-ug, yav, yav-cm, yi, yi-001, yi-ua, yo, yo-bj, yo-ng, yrl, yrl-br, yrl-co, yrl-ve, yue, yue-cn, yue-hk, yue-mo, za, za-cn, zgh, zgh-ma, zh, zh-cn, zh-hans, zh-hant, zh-hk, zh-mo, zh-my, zh-sg, zh-tw, zu, zu-za
name	string	Optional	The name of the email, as displayed on the email dashboard.
publishDate	string	Optional	The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails. Format: date-time
rssData	Model	Optional	Expand Create Email — request body — body rss Data
sendOnPublish	boolean	Optional	Determines whether the email will be sent immediately on publish.
state	string	Optional	The email state. One of: AGENT_GENERATED, AUTOMATED, AUTOMATED_AB, AUTOMATED_AB_VARIANT, AUTOMATED_DRAFT, AUTOMATED_DRAFT_AB, AUTOMATED_DRAFT_ABVARIANT, AUTOMATED_FOR_FORM, AUTOMATED_FOR_FORM_BUFFER, AUTOMATED_FOR_FORM_DRAFT, AUTOMATED_FOR_FORM_LEGACY, AUTOMATED_LOSER_ABVARIANT, AUTOMATED_SENDING, BLOG_EMAIL_DRAFT, BLOG_EMAIL_PUBLISHED, DRAFT, DRAFT_AB, DRAFT_AB_VARIANT, ERROR, LOSER_AB_VARIANT, PAGE_STUB, PRE_PROCESSING, PROCESSING, PUBLISHED, PUBLISHED_AB, PUBLISHED_AB_VARIANT, PUBLISHED_OR_SCHEDULED, RSS_TO_EMAIL_DRAFT, RSS_TO_EMAIL_PUBLISHED, SCHEDULED, SCHEDULED_AB, SCHEDULED_OR_PUBLISHED
subcategory	string	Optional	The email subcategory. One of: ab_loser_variant, ab_loser_variant_site_page, ab_master, ab_master_site_page, ab_variant, ab_variant_site_page, automated, automated_ab_master, automated_ab_variant, automated_for_crm, automated_for_custom_survey, automated_for_deal, automated_for_feedback_ces, automated_for_feedback_custom, automated_for_feedback_nps, automated_for_form, automated_for_form_buffer, automated_for_form_draft, automated_for_form_legacy, automated_for_leadflow, automated_for_ticket, batch, blog_article_instance_layout, blog_article_listing, blog_author_detail, blog_email, blog_email_child, case_study, case_study_instance_layout, case_study_listing, discardable_stub, imported_blog_post, kb_404_page, kb_article_instance_layout, kb_listing, kb_search_results, kb_support_form, landing_page, legacy_blog_post, legacy_page, localtime, manage_preferences_email, marketing_single_send_api, membership_email_verification, membership_follow_up, membership_otp_login, membership_password_reset, membership_password_saved, membership_passwordless_auth, membership_registration, membership_registration_follow_up, membership_verification, normal_blog_post, optin_email, optin_followup_email, page_instance_layout, page_stub, performable_landing_page, performable_landing_page_cutover, podcast_instance_layout, podcast_listing, portal_content, resubscribe_confirmation_email, resubscribe_email, rss_to_email, rss_to_email_child, scp_instance_layout_page, scp_static_page, single_send_api, site_page, smtp_token, staged_page, ticket_closed_kickback_email, ticket_opened_kickback_email, ticket_pipeline_automated, UNKNOWN, unsubscribe_confirmation_email, web_interactive
subject	string	Optional	The subject of the email.
subscriptionDetails	Model	Optional	Expand Create Email — response body — subscription Details
testing	Model	Optional	Expand Create Email — request body — body testing
to	Model	Optional	Expand Create Email — response body — to
webversion	Model	Optional	Expand Create Email — response body — webversion

Referenced models: Create Email — response body — from, Create Email — response body — subscription Details, Create Email — response body — to, Create Email — response body — webversion, Create Email — request body — body content, Create Email — request body — body testing, Create Email — request body — body rss Data

Create Email — request body — body content

Field	Type	Presence	Description and constraints
$	object	Root
flexAreas	object	Optional	An object containing flexible area configurations, where each key is an area identifier and the value is an object with area properties. Additional keys: see wildcard field
flexAreas.*	object	Additional keys
plainTextVersion	string	Optional	A string containing the plain text version of the email content.
smartFields	object	Optional	An object containing smart field configurations, where each key is a field identifier and the value is a SmartEmailField object. Additional keys: see wildcard field
smartFields.*	Model	Additional keys	Expand List tags — response body
styleSettings	Model	Optional	Expand Create Email — request body — body content style Settings
templatePath	string	Optional	A string representing the path to the email template used for this email.
themeSettingsValues	object	Optional	An object containing theme settings values, where each key is a setting identifier and the value is an object with setting properties. Additional keys: see wildcard field
themeSettingsValues.*	object	Additional keys
widgetContainers	object	Optional	An object containing widget container configurations, where each key is a container identifier and the value is an object with container properties. Additional keys: see wildcard field
widgetContainers.*	object	Additional keys
widgets	object	Optional	An object containing widget configurations, where each key is a widget identifier and the value is an object with widget properties. Additional keys: see wildcard field
widgets.*	object	Additional keys

Referenced models: List tags — response body, Create Email — request body — body content style Settings

Create Email — request body — body content style Settings

Field	Type	Presence	Description and constraints
$	object	Root
backgroundColor	string	Optional	The background color of the email, represented as a string.
backgroundImage	string	Optional	The URL of the background image used in the email.
backgroundImageType	string	Optional	The type of background image display, with valid values including 'SINGLE', 'STRETCH', and 'REPEAT'. One of: REPEAT, SINGLE, STRETCH
bodyBorderColor	string	Optional	The color of the border around the email body.
bodyBorderColorChoice	string	Optional	A string representing the choice of border color for the email body.
bodyBorderWidth	number	Optional	The width of the border around the email body, represented as a number.
bodyColor	string	Optional	The color of the email body, represented as a string.
buttonStyleSettings	Model	Optional	Expand Create Email — request body — body content style Settings button Style Settings
colorPickerFavorite1	string	Optional	A favorite color option available in the color picker, represented as a string.
colorPickerFavorite2	string	Optional	A favorite color option available in the color picker, represented as a string.
colorPickerFavorite3	string	Optional	A favorite color option available in the color picker, represented as a string.
colorPickerFavorite4	string	Optional	A favorite color option available in the color picker, represented as a string.
colorPickerFavorite5	string	Optional	A favorite color option available in the color picker, represented as a string.
colorPickerFavorite6	string	Optional	A favorite color option available in the color picker, represented as a string.
dividerStyleSettings	Model	Optional	Expand Create Email — request body — body content style Settings divider Style Settings
emailBodyPadding	string	Optional	The padding applied to the email body, represented as a string.
emailBodyWidth	string	Optional	The width of the email body, represented as a string.
headingOneFont	Model	Optional	Expand Create Email — request body — body content style Settings links Font
headingTwoFont	Model	Optional	Expand Create Email — request body — body content style Settings links Font
linksFont	Model	Optional	Expand Create Email — request body — body content style Settings links Font
primaryAccentColor	string	Optional	The primary accent color used in the email.
primaryFont	string	Optional	The primary font used in the email, represented as a string.
primaryFontColor	string	Optional	The color of the primary font.
primaryFontLineHeight	string	Optional	The line height of the primary font, represented as a string.
primaryFontSize	number	Optional	The size of the primary font, represented as a number.
secondaryAccentColor	string	Optional	The secondary accent color used in the email.
secondaryFont	string	Optional	The secondary font used in the email, represented as a string.
secondaryFontColor	string	Optional	The color of the secondary font.
secondaryFontLineHeight	string	Optional	The line height of the secondary font, represented as a string.
secondaryFontSize	number	Optional	The size of the secondary font, represented as a number.

Referenced models: Create Email — request body — body content style Settings button Style Settings, Create Email — request body — body content style Settings divider Style Settings, Create Email — request body — body content style Settings links Font

Create Email — request body — body content style Settings button Style Settings

Field	Type	Presence	Description and constraints
$	object	Root
backgroundColor	object	Optional	An object representing the background color of the button.
cornerRadius	integer	Optional	An integer specifying the radius of the button's corners. Format: int32
fontStyle	Model	Optional	Expand Create Email — request body — body content style Settings links Font

Referenced models: Create Email — request body — body content style Settings links Font

Create Email — request body — body content style Settings divider Style Settings

Field	Type	Presence	Description and constraints
$	object	Root
color	object	Optional	An object representing the color settings of the divider.
height	integer	Optional	An integer representing the height of the divider. Format: int32
lineType	string	Optional	A string indicating the type of line used for the divider.

Create Email — request body — body content style Settings links Font

Field	Type	Presence	Description and constraints
$	object	Root
bold	boolean	Optional	A boolean indicating whether the text should be bold.
color	string	Optional	The color of the font, represented as a string.
font	string	Optional	The type of font to be used, represented as a string.
italic	boolean	Optional	A boolean indicating whether the text should be italicized.
size	integer	Optional	The size of the font, represented as an integer. Format: int32
underline	boolean	Optional	A boolean indicating whether the text should be underlined.

Create Email — request body — body rss Data

Field	Type	Presence	Description and constraints
$	object	Root
blogEmailType	string	Optional	A string representing the type of blog email.
blogImageMaxWidth	integer	Optional	The maximum width for images in the blog, specified as an integer. Format: int32
blogLayout	string	Optional	The layout of the blog in the email. Valid values include 'SUMMARY_NO_FEATURED_IMAGE', 'SUMMARY_WITH_FEATURED_IMAGE', and 'FULL_POST'. One of: FULL_POST, SUMMARY_NO_FEATURED_IMAGE, SUMMARY_WITH_FEATURED_IMAGE
hubspotBlogId	string	Optional	The unique identifier of the HubSpot blog associated with the RSS email. It is a string.
maxEntries	integer	Optional	The maximum number of entries to include from the RSS feed. It is an integer value. Format: int32
rssEntryTemplate	string	Optional	A string representing the template used for each RSS entry in the email.
timing	object	Optional	An object representing the timing configuration for the RSS email. The specific properties of this object are not detailed in the specification. Additional keys: see wildcard field
timing.*	object	Additional keys
url	string	Optional	The URL of the RSS feed to be used in the email. It is a string.
useHeadlineAsSubject	boolean	Optional	A boolean indicating whether to use the headline of the RSS entry as the subject of the email.

Create Email — request body — body testing

Field	Type	Presence	Description and constraints
$	object	Root
abSampleSizeDefault	string	Optional	Version of the email that should be sent if there are too few recipients to conduct an AB test. One of: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant
abSamplingDefault	string	Optional	Version of the email that should be sent if the results are inconclusive after the test period, master or variant. One of: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant
abStatus	string	Optional	Status of the AB test. One of: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant
abSuccessMetric	string	Optional	Metric to determine the version that will be sent to the remaining contacts. One of: CLICKS_BY_DELIVERED, CLICKS_BY_OPENS, OPENS_BY_DELIVERED
abTestPercentage	integer	Optional	The size of your test group. Format: int32
hoursToWait	integer	Optional	Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts. Format: int32
isAbVariation	boolean	Required within parent	A boolean indicating whether the email is an A/B test variation.
testId	string	Optional	The ID of the AB test.

Create Email — response body

Field	Type	Presence	Description and constraints
$	object	Root
activeDomain	string	Optional	The active domain of the email.
allEmailCampaignIds	array	Optional	List of emailCampaignIds.
allEmailCampaignIds[]	string	Each item
archived	boolean	Optional	Determines if the email is archived or not.
businessUnitId	string	Optional	The ID of the business unit associated with the email.
campaign	string	Optional	The ID of the campaign this email is associated to.
campaignName	string	Optional	The name of the campaign.
campaignUtm	string	Optional	The UTM parameters associated with the email's campaign.
clonedFrom	string	Optional	The ID of the email this email was cloned from.
content	Model	Optional	Expand Create Email — response body — content
createdAt	string	Optional	The date and time of the email's creation, in ISO8601 representation. Format: date-time
createdById	string	Optional	The id of the user who created the email.
deletedAt	string	Optional	The date and time the email was deleted at, in ISO8601 representation. Format: date-time
emailCampaignGroupId	string	Optional	The ID of the email campaign group associated with the email.
emailTemplateMode	string	Optional	The mode of the email template, such as 'DESIGN_MANAGER' or 'DRAG_AND_DROP'. Known values: DESIGN_MANAGER, DRAG_AND_DROP
feedbackSurveyId	string	Optional	The ID of the feedback survey linked to the email.
folderId	JSON	Optional
folderId (anyOf 1)	integer	Alternative	Deprecated — this field is no longer functional. Use folderIdV2 instead. Format: int64
folderId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
folderIdV2	JSON	Optional
folderIdV2 (anyOf 1)	integer	Alternative	The version 2 ID of the folder where the email is stored, as a 64-bit integer. Format: int64
folderIdV2 (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
from	Model	Optional	Expand Create Email — response body — from
id	string	Optional	The email ID.
isAb	boolean	Required within parent	A boolean indicating whether the email is part of an A/B test.
isPublished	boolean	Optional	Returns the published status of the email. This is read only.
isTransactional	boolean	Optional	Returns whether the email is a transactional email or not. This is read only.
jitterSendTime	boolean	Optional	A boolean indicating whether to apply a jitter to the send time.
language	string	Optional	The language code of the email, following ISO 639-1 and ISO 3166-1 standards. Known values: aa, ab, ae, af, af-na, af-za, agq, agq-cm, ak, ak-gh, am, am-et, an, ann, ann-ng, ar, ar-001, ar-ae, ar-bh, ar-dj, ar-dz, ar-eg, ar-eh, ar-er, ar-il, ar-iq, ar-jo, ar-km, ar-kw, ar-lb, ar-ly, ar-ma, ar-mr, ar-om, ar-ps, ar-qa, ar-sa, ar-sd, ar-so, ar-ss, ar-sy, ar-td, ar-tn, ar-ye, as, as-in, asa, asa-tz, ast, ast-es, av, ay, az, az-az, ba, bal, bal-pk, bas, bas-cm, be, be-by, bem, bem-zm, bez, bez-tz, bg, bg-bg, bgc, bgc-in, bho, bho-in, bi, blo, blo-bj, bm, bm-ml, bn, bn-bd, bn-in, bo, bo-cn, bo-in, br, br-fr, brx, brx-in, bs, bs-ba, ca, ca-ad, ca-es, ca-fr, ca-it, ccp, ccp-bd, ccp-in, ce, ce-ru, ceb, ceb-ph, cgg, cgg-ug, ch, chr, chr-us, ckb, ckb-iq, ckb-ir, co, cr, cs, cs-cz, csw, csw-ca, cu, cu-ru, cv, cv-ru, cy, cy-gb, da, da-dk, da-gl, dav, dav-ke, de, de-at, de-be, de-ch, de-de, de-gr, de-it, de-li, de-lu, dje, dje-ne, doi, doi-in, dsb, dsb-de, dua, dua-cm, dv, dyo, dyo-sn, dz, dz-bt, ebu, ebu-ke, ee, ee-gh, ee-tg, el, el-cy, el-gr, en, en-001, en-150, en-ae, en-ag, en-ai, en-as, en-at, en-au, en-bb, en-be, en-bi, en-bm, en-bs, en-bw, en-bz, en-ca, en-cc, en-ch, en-ck, en-cm, en-cn, en-cx, en-cy, en-cz, en-de, en-dg, en-dk, en-dm, en-ee, en-eg, en-er, en-es, en-fi, en-fj, en-fk, en-fm, en-fr, en-gb, en-gd, en-gg, en-gh, en-gi, en-gm, en-gs, en-gu, en-gy, en-hk, en-hu, en-id, en-ie, en-il, en-im, en-in, en-io, en-it, en-je, en-jm, en-ke, en-ki, en-kn, en-ky, en-lc, en-lr, en-ls, en-lu, en-mg, en-mh, en-mo, en-mp, en-ms, en-mt, en-mu, en-mv, en-mw, en-mx, en-my, en-na, en-nf, en-ng, en-nl, en-no, en-nr, en-nu, en-nz, en-pg, en-ph, en-pk, en-pl, en-pn, en-pr, en-pt, en-pw, en-ro, en-rw, en-sb, en-sc, en-sd, en-se, en-sg, en-sh, en-si, en-sk, en-sl, en-ss, en-sx, en-sz, en-tc, en-th, en-tk, en-tn, en-to, en-tt, en-tv, en-tz, en-ug, en-um, en-us, en-vc, en-vg, en-vi, en-vn, en-vu, en-ws, en-za, en-zm, en-zw, eo, eo-001, es, es-419, es-ar, es-bo, es-br, es-bz, es-cl, es-co, es-cr, es-cu, es-do, es-ea, es-ec, es-es, es-gq, es-gt, es-hn, es-ic, es-mx, es-ni, es-pa, es-pe, es-ph, es-pr, es-py, es-sv, es-us, es-uy, es-ve, et, et-ee, eu, eu-es, ewo, ewo-cm, fa, fa-af, fa-ir, ff, ff-bf, ff-cm, ff-gh, ff-gm, ff-gn, ff-gw, ff-lr, ff-mr, ff-ne, ff-ng, ff-sl, ff-sn, fi, fi-fi, fil, fil-ph, fj, fo, fo-dk, fo-fo, fr, fr-be, fr-bf, fr-bi, fr-bj, fr-bl, fr-ca, fr-cd, fr-cf, fr-cg, fr-ch, fr-ci, fr-cm, fr-dj, fr-dz, fr-fr, fr-ga, fr-gf, fr-gn, fr-gp, fr-gq, fr-ht, fr-km, fr-lu, fr-ma, fr-mc, fr-mf, fr-mg, fr-ml, fr-mq, fr-mr, fr-mu, fr-nc, fr-ne, fr-pf, fr-pm, fr-re, fr-rw, fr-sc, fr-sn, fr-sy, fr-td, fr-tg, fr-tn, fr-vu, fr-wf, fr-yt, frr, frr-de, fur, fur-it, fy, fy-nl, ga, ga-gb, ga-ie, gaa, gaa-gh, gd, gd-gb, gl, gl-es, gn, gsw, gsw-ch, gsw-fr, gsw-li, gu, gu-in, guz, guz-ke, gv, gv-im, ha, ha-gh, ha-ne, ha-ng, haw, haw-us, he, he-il, hi, hi-in, hmn, ho, hr, hr-ba, hr-hr, hsb, hsb-de, ht, ht-ht, hu, hu-hu, hy, hy-am, hz, ia, ia-001, id, id-id, ie, ie-ee, ig, ig-ng, ii, ii-cn, ik, io, is, is-is, it, it-ch, it-it, it-sm, it-va, iu, ja, ja-jp, jgo, jgo-cm, jmc, jmc-tz, jv, jv-id, ka, ka-ge, kab, kab-dz, kam, kam-ke, kar, kde, kde-tz, kea, kea-cv, kg, kgp, kgp-br, kh, khq, khq-ml, ki, ki-ke, kj, kk, kk-kz, kkj, kkj-cm, kl, kl-gl, kln, kln-ke, km, km-kh, kn, kn-in, ko, ko-cn, ko-kp, ko-kr, kok, kok-in, kr, ks, ks-in, ksb, ksb-tz, ksf, ksf-cm, ksh, ksh-de, ku, ku-tr, kv, kw, kw-gb, kxv, kxv-in, ky, ky-kg, la, lag, lag-tz, lb, lb-lu, lg, lg-ug, li, lij, lij-it, lkt, lkt-us, lmo, lmo-it, ln, ln-ao, ln-cd, ln-cf, ln-cg, lo, lo-la, lrc, lrc-iq, lrc-ir, lt, lt-lt, lu, lu-cd, luo, luo-ke, luy, luy-ke, lv, lv-lv, mai, mai-in, mas, mas-ke, mas-tz, mdf, mdf-ru, mer, mer-ke, mfe, mfe-mu, mg, mg-mg, mgh, mgh-mz, mgo, mgo-cm, mh, mi, mi-nz, mk, mk-mk, ml, ml-in, mn, mn-mn, mni, mni-in, mr, mr-in, ms, ms-bn, ms-id, ms-my, ms-sg, mt, mt-mt, mua, mua-cm, my, my-mm, mzn, mzn-ir, na, naq, naq-na, nb, nb-no, nb-sj, nd, nd-zw, nds, nds-de, nds-nl, ne, ne-in, ne-np, ng, nl, nl-aw, nl-be, nl-bq, nl-ch, nl-cw, nl-lu, nl-nl, nl-sr, nl-sx, nmg, nmg-cm, nn, nn-no, nnh, nnh-cm, no, no-no, nqo, nqo-gn, nr, nso, nso-za, nus, nus-ss, nv, ny, nyn, nyn-ug, oc, oc-es, oc-fr, oj, om, om-et, om-ke, or, or-in, os, os-ge, os-ru, pa, pa-in, pa-pk, pcm, pcm-ng, pi, pis, pis-sb, pl, pl-pl, prg, prg-001, ps, ps-af, ps-pk, pt, pt-ao, pt-br, pt-ch, pt-cv, pt-gq, pt-gw, pt-lu, pt-mo, pt-mz, pt-pt, pt-st, pt-tl, qu, qu-bo, qu-ec, qu-pe, raj, raj-in, rm, rm-ch, rn, rn-bi, ro, ro-md, ro-ro, rof, rof-tz, ru, ru-by, ru-kg, ru-kz, ru-md, ru-ru, ru-ua, rw, rw-rw, rwk, rwk-tz, sa, sa-in, sah, sah-ru, saq, saq-ke, sat, sat-in, sbp, sbp-tz, sc, sc-it, sd, sd-in, sd-pk, se, se-fi, se-no, se-se, seh, seh-mz, ses, ses-ml, sg, sg-cf, shi, shi-ma, si, si-lk, sk, sk-sk, sl, sl-si, sm, smn, smn-fi, sms, sms-fi, sn, sn-zw, so, so-dj, so-et, so-ke, so-so, sq, sq-al, sq-mk, sq-xk, sr, sr-ba, sr-cs, sr-me, sr-rs, sr-xk, ss, st, st-ls, st-za, su, su-id, sv, sv-ax, sv-fi, sv-se, sw, sw-cd, sw-ke, sw-tz, sw-ug, sy, syr, syr-iq, syr-sy, szl, szl-pl, ta, ta-in, ta-lk, ta-my, ta-sg, te, te-in, teo, teo-ke, teo-ug, tg, tg-tj, th, th-th, ti, ti-er, ti-et, tk, tk-tm, tl, tn, tn-bw, tn-za, to, to-to, tok, tok-001, tr, tr-cy, tr-tr, ts, tt, tt-ru, tw, twq, twq-ne, ty, tzm, tzm-ma, ug, ug-cn, uk, uk-ua, ur, ur-in, ur-pk, uz, uz-af, uz-uz, vai, vai-lr, ve, vec, vec-it, vi, vi-vn, vmw, vmw-mz, vo, vo-001, vun, vun-tz, wa, wae, wae-ch, wo, wo-sn, xh, xh-za, xnr, xnr-in, xog, xog-ug, yav, yav-cm, yi, yi-001, yi-ua, yo, yo-bj, yo-ng, yrl, yrl-br, yrl-co, yrl-ve, yue, yue-cn, yue-hk, yue-mo, za, za-cn, zgh, zgh-ma, zh, zh-cn, zh-hans, zh-hant, zh-hk, zh-mo, zh-my, zh-sg, zh-tw, zu, zu-za
name	string	Optional	The name of the email, as displayed on the email dashboard.
previewKey	string	Optional	The preview key for the email.
primaryEmailCampaignId	string	Optional	The primary email campaign ID associated with the email.
publishDate	string	Optional	The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails. Format: date-time
publishedAt	string	Optional	The date and time the email was published at, in ISO8601 representation. Format: date-time
publishedByEmail	string	Optional	Email of the user who published/sent the email.
publishedById	string	Optional	The ID of the user who published the email.
publishedByName	string	Optional	Name of the user who published the email.
rssData	Model	Optional	Expand Create Email — response body — rss Data
sendOnPublish	boolean	Optional	Determines whether the email will be sent immediately on publish.
state	string	Optional	The email state. Known values: AGENT_GENERATED, AUTOMATED, AUTOMATED_AB, AUTOMATED_AB_VARIANT, AUTOMATED_DRAFT, AUTOMATED_DRAFT_AB, AUTOMATED_DRAFT_ABVARIANT, AUTOMATED_FOR_FORM, AUTOMATED_FOR_FORM_BUFFER, AUTOMATED_FOR_FORM_DRAFT, AUTOMATED_FOR_FORM_LEGACY, AUTOMATED_LOSER_ABVARIANT, AUTOMATED_SENDING, BLOG_EMAIL_DRAFT, BLOG_EMAIL_PUBLISHED, DRAFT, DRAFT_AB, DRAFT_AB_VARIANT, ERROR, LOSER_AB_VARIANT, PAGE_STUB, PRE_PROCESSING, PROCESSING, PUBLISHED, PUBLISHED_AB, PUBLISHED_AB_VARIANT, PUBLISHED_OR_SCHEDULED, RSS_TO_EMAIL_DRAFT, RSS_TO_EMAIL_PUBLISHED, SCHEDULED, SCHEDULED_AB, SCHEDULED_OR_PUBLISHED
stats	Model	Optional	Expand Create Email — response body — stats
subcategory	string	Optional	The email subcategory.
subject	string	Optional	The subject of the email.
subscriptionDetails	Model	Optional	Expand Create Email — response body — subscription Details
teamsWithAccess	array	Optional	An array of team IDs who have access to the email.
teamsWithAccess[]	string	Each item
testing	Model	Optional	Expand Create Email — response body — testing
to	Model	Optional	Expand Create Email — response body — to
type	string	Optional	The email type, this is derived from other properties on the email such as subcategory. Known values: AB_EMAIL, AUTOMATED_AB_EMAIL, AUTOMATED_EMAIL, BATCH_EMAIL, BLOG_EMAIL, BLOG_EMAIL_CHILD, FEEDBACK_CES_EMAIL, FEEDBACK_CUSTOM_EMAIL, FEEDBACK_CUSTOM_SURVEY_EMAIL, FEEDBACK_NPS_EMAIL, FOLLOWUP_EMAIL, LEADFLOW_EMAIL, LOCALTIME_EMAIL, MANAGE_PREFERENCES_EMAIL, MARKETING_SINGLE_SEND_API, MEMBERSHIP_EMAIL_VERIFICATION_EMAIL, MEMBERSHIP_FOLLOW_UP_EMAIL, MEMBERSHIP_OTP_LOGIN_EMAIL, MEMBERSHIP_PASSWORD_RESET_EMAIL, MEMBERSHIP_PASSWORD_SAVED_EMAIL, MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL, MEMBERSHIP_REGISTRATION_EMAIL, MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL, MEMBERSHIP_VERIFICATION_EMAIL, OPTIN_EMAIL, OPTIN_FOLLOWUP_EMAIL, RESUBSCRIBE_EMAIL, RSS_EMAIL, RSS_EMAIL_CHILD, SINGLE_SEND_API, SMTP_TOKEN, TICKET_EMAIL
unpublishedAt	string	Optional	The date and time when the email was unpublished, in ISO 8601 format. Format: date-time
updatedAt	string	Optional	The date and time of the last update to the email, in ISO8601 representation. Format: date-time
updatedById	string	Optional	The id of the user who last updated the email.
usersWithAccess	array	Optional	An array of user IDs who have access to the email.
usersWithAccess[]	string	Each item
webversion	Model	Optional	Expand Create Email — response body — webversion
workflowNames	array	Optional	Names of workflows in which the email is used within a "send email" action.
workflowNames[]	string	Each item

Referenced models: Create Email — response body — stats, Create Email — response body — content, Create Email — response body — from, Create Email — response body — subscription Details, Create Email — response body — testing, Create Email — response body — to, Create Email — response body — rss Data, Create Email — response body — webversion

Create Email — response body — content

Field	Type	Presence	Description and constraints
$	object	Root
flexAreas	object	Optional	An object containing flexible area configurations, where each key is an area identifier and the value is an object with area properties. Additional keys: see wildcard field
flexAreas.*	object	Additional keys
plainTextVersion	string	Optional	A string containing the plain text version of the email content.
smartFields	object	Optional	An object containing smart field configurations, where each key is a field identifier and the value is a SmartEmailField object. Additional keys: see wildcard field
smartFields.*	Model	Additional keys	Expand List tags — response body
styleSettings	Model	Optional	Expand Create Email — response body — content style Settings
templatePath	string	Optional	A string representing the path to the email template used for this email.
themeSettingsValues	object	Optional	An object containing theme settings values, where each key is a setting identifier and the value is an object with setting properties. Additional keys: see wildcard field
themeSettingsValues.*	object	Additional keys
widgetContainers	object	Optional	An object containing widget container configurations, where each key is a container identifier and the value is an object with container properties. Additional keys: see wildcard field
widgetContainers.*	object	Additional keys
widgets	object	Optional	An object containing widget configurations, where each key is a widget identifier and the value is an object with widget properties. Additional keys: see wildcard field
widgets.*	object	Additional keys

Referenced models: List tags — response body, Create Email — response body — content style Settings

Create Email — response body — content style Settings

Field	Type	Presence	Description and constraints
$	object	Root
backgroundColor	string	Optional	The background color of the email, represented as a string.
backgroundImage	string	Optional	The URL of the background image used in the email.
backgroundImageType	string	Optional	The type of background image display, with valid values including 'SINGLE', 'STRETCH', and 'REPEAT'. Known values: REPEAT, SINGLE, STRETCH
bodyBorderColor	string	Optional	The color of the border around the email body.
bodyBorderColorChoice	string	Optional	A string representing the choice of border color for the email body.
bodyBorderWidth	JSON	Optional
bodyBorderWidth (anyOf 1)	number	Alternative	The width of the border around the email body, represented as a number.
bodyBorderWidth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
bodyColor	string	Optional	The color of the email body, represented as a string.
buttonStyleSettings	Model	Optional	Expand Create Email — response body — content style Settings button Style Settings
colorPickerFavorite1	string	Optional	A favorite color option available in the color picker, represented as a string.
colorPickerFavorite2	string	Optional	A favorite color option available in the color picker, represented as a string.
colorPickerFavorite3	string	Optional	A favorite color option available in the color picker, represented as a string.
colorPickerFavorite4	string	Optional	A favorite color option available in the color picker, represented as a string.
colorPickerFavorite5	string	Optional	A favorite color option available in the color picker, represented as a string.
colorPickerFavorite6	string	Optional	A favorite color option available in the color picker, represented as a string.
dividerStyleSettings	Model	Optional	Expand Create Email — response body — content style Settings divider Style Settings
emailBodyPadding	string	Optional	The padding applied to the email body, represented as a string.
emailBodyWidth	string	Optional	The width of the email body, represented as a string.
headingOneFont	Model	Optional	Expand Create Email — response body — content style Settings links Font
headingTwoFont	Model	Optional	Expand Create Email — response body — content style Settings links Font
linksFont	Model	Optional	Expand Create Email — response body — content style Settings links Font
primaryAccentColor	string	Optional	The primary accent color used in the email.
primaryFont	string	Optional	The primary font used in the email, represented as a string.
primaryFontColor	string	Optional	The color of the primary font.
primaryFontLineHeight	string	Optional	The line height of the primary font, represented as a string.
primaryFontSize	JSON	Optional
primaryFontSize (anyOf 1)	number	Alternative	The size of the primary font, represented as a number.
primaryFontSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
secondaryAccentColor	string	Optional	The secondary accent color used in the email.
secondaryFont	string	Optional	The secondary font used in the email, represented as a string.
secondaryFontColor	string	Optional	The color of the secondary font.
secondaryFontLineHeight	string	Optional	The line height of the secondary font, represented as a string.
secondaryFontSize	JSON	Optional
secondaryFontSize (anyOf 1)	number	Alternative	The size of the secondary font, represented as a number.
secondaryFontSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create Email — response body — content style Settings button Style Settings, Create Email — response body — content style Settings divider Style Settings, Create Email — response body — content style Settings links Font

Create Email — response body — content style Settings button Style Settings

Field	Type	Presence	Description and constraints
$	object	Root
backgroundColor	object	Optional	An object representing the background color of the button.
cornerRadius	JSON	Optional
cornerRadius (anyOf 1)	integer	Alternative	An integer specifying the radius of the button's corners. Format: int32
cornerRadius (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fontStyle	Model	Optional	Expand Create Email — response body — content style Settings links Font

Referenced models: Create Email — response body — content style Settings links Font

Create Email — response body — content style Settings divider Style Settings

Field	Type	Presence	Description and constraints
$	object	Root
color	object	Optional	An object representing the color settings of the divider.
height	JSON	Optional
height (anyOf 1)	integer	Alternative	An integer representing the height of the divider. Format: int32
height (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lineType	string	Optional	A string indicating the type of line used for the divider.

Create Email — response body — content style Settings links Font

Field	Type	Presence	Description and constraints
$	object	Root
bold	boolean	Optional	A boolean indicating whether the text should be bold.
color	string	Optional	The color of the font, represented as a string.
font	string	Optional	The type of font to be used, represented as a string.
italic	boolean	Optional	A boolean indicating whether the text should be italicized.
size	JSON	Optional
size (anyOf 1)	integer	Alternative	The size of the font, represented as an integer. Format: int32
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
underline	boolean	Optional	A boolean indicating whether the text should be underlined.

Create Email — response body — from

Field	Type	Presence	Description and constraints
$	object	Root
customReplyTo	string	Optional	The reply to recipients will see.
fromName	string	Optional	The name recipients will see.
replyTo	string	Optional	The from address and reply to email address (if no customReplyTo defined) recipients will see.

Create Email — response body — rss Data

Field	Type	Presence	Description and constraints
$	object	Root
blogEmailType	string	Optional	A string representing the type of blog email.
blogImageMaxWidth	JSON	Optional
blogImageMaxWidth (anyOf 1)	integer	Alternative	The maximum width for images in the blog, specified as an integer. Format: int32
blogImageMaxWidth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
blogLayout	string	Optional	The layout of the blog in the email. Valid values include 'SUMMARY_NO_FEATURED_IMAGE', 'SUMMARY_WITH_FEATURED_IMAGE', and 'FULL_POST'. Known values: FULL_POST, SUMMARY_NO_FEATURED_IMAGE, SUMMARY_WITH_FEATURED_IMAGE
hubspotBlogId	string	Optional	The unique identifier of the HubSpot blog associated with the RSS email. It is a string.
maxEntries	JSON	Optional
maxEntries (anyOf 1)	integer	Alternative	The maximum number of entries to include from the RSS feed. It is an integer value. Format: int32
maxEntries (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rssEntryTemplate	string	Optional	A string representing the template used for each RSS entry in the email.
timing	object	Optional	An object representing the timing configuration for the RSS email. The specific properties of this object are not detailed in the specification. Additional keys: see wildcard field
timing.*	object	Additional keys
url	string	Optional	The URL of the RSS feed to be used in the email. It is a string.
useHeadlineAsSubject	boolean	Optional	A boolean indicating whether to use the headline of the RSS entry as the subject of the email.

Create Email — response body — stats

Field	Type	Presence	Description and constraints
$	object	Root
counters	object	Required within parent	Counters like number of `sent`, `open` or `delivered`. Additional keys: see wildcard field
counters.*	JSON	Additional keys
counters.* (anyOf 1)	integer	Alternative	Format: int64
counters.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deviceBreakdown	object	Required within parent	Statistics by device. Additional keys: see wildcard field
deviceBreakdown.*	object	Additional keys	Additional keys: see wildcard field
deviceBreakdown.*.*	JSON	Additional keys
deviceBreakdown.*.* (anyOf 1)	integer	Alternative	Format: int64
deviceBreakdown.*.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
qualifierStats	object	Required within parent	Number of emails that were dropped and bounced. Additional keys: see wildcard field
qualifierStats.*	object	Additional keys	Additional keys: see wildcard field
qualifierStats.*.*	JSON	Additional keys
qualifierStats.*.* (anyOf 1)	integer	Alternative	Format: int64
qualifierStats.*.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ratios	object	Required within parent	Ratios like `openratio` or `clickratio` Additional keys: see wildcard field
ratios.*	JSON	Additional keys
ratios.* (anyOf 1)	number	Alternative
ratios.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create Email — response body — subscription Details

Field	Type	Presence	Description and constraints
$	object	Root
officeLocationId	string	Optional	ID of the selected office location.
preferencesGroupId	string	Optional	The identifier for the preferences group associated with the subscription. It is a string value.
subscriptionId	string	Optional	ID of the subscription.
subscriptionName	string	Optional	The name of the email subscription. It is a string value.

Create Email — response body — testing

Field	Type	Presence	Description and constraints
$	object	Root
abSampleSizeDefault	string	Optional	Version of the email that should be sent if there are too few recipients to conduct an AB test. Known values: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant
abSamplingDefault	string	Optional	Version of the email that should be sent if the results are inconclusive after the test period, master or variant. Known values: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant
abStatus	string	Optional	Status of the AB test. Known values: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant
abSuccessMetric	string	Optional	Metric to determine the version that will be sent to the remaining contacts. Known values: CLICKS_BY_DELIVERED, CLICKS_BY_OPENS, OPENS_BY_DELIVERED
abTestPercentage	JSON	Optional
abTestPercentage (anyOf 1)	integer	Alternative	The size of your test group. Format: int32
abTestPercentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hoursToWait	JSON	Optional
hoursToWait (anyOf 1)	integer	Alternative	Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts. Format: int32
hoursToWait (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
isAbVariation	boolean	Required within parent	A boolean indicating whether the email is an A/B test variation.
testId	string	Optional	The ID of the AB test.

Create Email — response body — to

Field	Type	Presence	Description and constraints
$	object	Root
contactIds	Model	Optional	Expand Create Email — response body — to contact Ids
contactIlsLists	Model	Optional	Expand Create Email — response body — to contact Ids
contactLists	Model	Optional	Expand Create Email — response body — to contact Ids
limitSendFrequency	boolean	Optional	A boolean indicating whether the frequency of sending emails to the recipients should be limited.
suppressGraymail	boolean	Optional	Whether to send to unengaged contacts (false) or not (true).

Referenced models: Create Email — response body — to contact Ids

Create Email — response body — to contact Ids

Field	Type	Presence	Description and constraints
$	object	Root
exclude	array	Optional	Excluded IDs.
exclude[]	string	Each item
include	array	Optional	Included IDs.
include[]	string	Each item

Create Email — response body — webversion

Field	Type	Presence	Description and constraints
$	object	Root
domain	string	Optional	A string specifying the domain where the web version of the email is hosted.
enabled	boolean	Optional	A boolean indicating whether the web version of the email is enabled.
expiresAt	string	Optional	A string in date-time format specifying when the web version page will expire. Format: date-time
isPageRedirected	boolean	Optional	A boolean indicating whether the web version page is redirected to another URL.
metaDescription	string	Optional	A string providing the meta description for the web version of the email.
pageExpiryEnabled	boolean	Optional	A boolean indicating whether the web version page has an expiry set.
redirectToPageId	string	Optional	A string representing the ID of the page to which the web version is redirected.
redirectToUrl	string	Optional	A string containing the URL to which the web version page is redirected.
slug	string	Optional	A string representing the unique slug for the web version of the email.
title	string	Optional	A string representing the title of the web version of the email.
url	string	Optional	A string containing the full URL of the web version of the email.

Create an A B test variation of a marketing email — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contentId	string	Required within parent	ID of the object to test.
variationName	string	Required within parent	Name of the variation to be created.

Get a revision of a marketing email — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for this version of the public email.
object	Model	Required within parent	Expand Create Email — response body
updatedAt	string	Required within parent	The date and time when this version of the email was last updated, in ISO 8601 format. Format: date-time
user	Model	Required within parent	Expand Get a revision of a marketing email — response body — user

Referenced models: Get a revision of a marketing email — response body — user, Create Email — response body

Get a revision of a marketing email — response body — user

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	Email address of the user.
fullName	string	Required within parent	First and last name of the user.
id	string	Required within parent	ID of the user.

Get aggregated statistic intervals — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Emails — response body — paging
results	array	Required within parent	An array of EmailStatisticInterval objects, each representing statistics for a specific time interval.
results[]	Model	Each item	Expand Get aggregated statistic intervals — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of email statistic intervals available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Emails — response body — paging, Get aggregated statistic intervals — response body — results item

Get aggregated statistic intervals — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
aggregations	Model	Required within parent	Expand Create Email — response body — stats
interval	Model	Required within parent	Expand Get aggregated statistic intervals — response body — results item interval

Referenced models: Get aggregated statistic intervals — response body — results item interval, Create Email — response body — stats

Get aggregated statistic intervals — response body — results item interval

Field	Type	Presence	Description and constraints
$	object	Root
end	string	Required within parent	The end timestamp of the interval, in ISO8601 format. Format: date-time
start	string	Required within parent	The start timestamp of the interval, in ISO8601 format. Format: date-time

Get aggregated statistics — response body

Field	Type	Presence	Description and constraints
$	object	Root
aggregate	Model	Required within parent	Expand Create Email — response body — stats
campaignAggregations	object	Required within parent	The aggregated statistics per campaign. Additional keys: see wildcard field
campaignAggregations.*	Model	Additional keys	Expand Create Email — response body — stats
emails	array	Required within parent	List of email IDs that were sent during the time span.
emails[]	JSON	Each item
emails[] (anyOf 1)	integer	Alternative	Format: int64
emails[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create Email — response body — stats

Get revisions of a marketing email — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Emails — response body — paging
results	array	Required within parent	An array of email version objects, each conforming to the VersionPublicEmail schema.
results[]	Model	Each item	Expand Get revisions of a marketing email — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of email version results available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Emails — response body — paging, Get revisions of a marketing email — response body — results item

Get revisions of a marketing email — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	ID of this marketing email version.
object	Model	Required within parent	Expand Create Email — response body
updatedAt	string	Required within parent	The date and time of the last update to the email, in ISO8601 representation. Format: date-time
user	Model	Required within parent	Expand Get a revision of a marketing email — response body — user

Referenced models: Get a revision of a marketing email — response body — user, Create Email — response body

List Emails — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Emails — response body — paging
results	array	Required within parent	An array containing the public email objects retrieved in the current page of results.
results[]	Model	Each item	Expand Create Email — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of public emails available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Emails — response body — paging, Create Email — response body

List Emails — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand List Emails — response body — paging next
prev	Model	Optional	Expand List Emails — response body — paging prev

Referenced models: List Emails — response body — paging next, List Emails — response body — paging prev

List Emails — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	The cursor token value to get the next set of results. Use this value as query parameter (&after=...) to obtain the next page.
link	string	Optional	The link to the next page.

List Emails — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	The cursor token value to get the previous set of results. Use this value as query parameter (&before=...) to obtain the previous page.
link	string	Optional	The link to the previous page.

Update a marketing email — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
activeDomain	string	Optional	The active domain of the email.
archived	boolean	Optional	Determines if the email is archived or not.
businessUnitId	integer	Optional	The ID of the business unit associated with the email. Format: int64
campaign	string	Optional	The ID of the campaign this email is associated to.
content	Model	Optional	Expand Create Email — request body — body content
folderIdV2	integer	Optional	The ID of the folder where the email will be stored. Format: int64
from	Model	Optional	Expand Create Email — response body — from
jitterSendTime	boolean	Optional	Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.
language	string	Optional	The language code for the email, such as 'en' for English. One of: aa, ab, ae, af, af-na, af-za, agq, agq-cm, ak, ak-gh, am, am-et, an, ann, ann-ng, ar, ar-001, ar-ae, ar-bh, ar-dj, ar-dz, ar-eg, ar-eh, ar-er, ar-il, ar-iq, ar-jo, ar-km, ar-kw, ar-lb, ar-ly, ar-ma, ar-mr, ar-om, ar-ps, ar-qa, ar-sa, ar-sd, ar-so, ar-ss, ar-sy, ar-td, ar-tn, ar-ye, as, as-in, asa, asa-tz, ast, ast-es, av, ay, az, az-az, ba, bal, bal-pk, bas, bas-cm, be, be-by, bem, bem-zm, bez, bez-tz, bg, bg-bg, bgc, bgc-in, bho, bho-in, bi, blo, blo-bj, bm, bm-ml, bn, bn-bd, bn-in, bo, bo-cn, bo-in, br, br-fr, brx, brx-in, bs, bs-ba, ca, ca-ad, ca-es, ca-fr, ca-it, ccp, ccp-bd, ccp-in, ce, ce-ru, ceb, ceb-ph, cgg, cgg-ug, ch, chr, chr-us, ckb, ckb-iq, ckb-ir, co, cr, cs, cs-cz, csw, csw-ca, cu, cu-ru, cv, cv-ru, cy, cy-gb, da, da-dk, da-gl, dav, dav-ke, de, de-at, de-be, de-ch, de-de, de-gr, de-it, de-li, de-lu, dje, dje-ne, doi, doi-in, dsb, dsb-de, dua, dua-cm, dv, dyo, dyo-sn, dz, dz-bt, ebu, ebu-ke, ee, ee-gh, ee-tg, el, el-cy, el-gr, en, en-001, en-150, en-ae, en-ag, en-ai, en-as, en-at, en-au, en-bb, en-be, en-bi, en-bm, en-bs, en-bw, en-bz, en-ca, en-cc, en-ch, en-ck, en-cm, en-cn, en-cx, en-cy, en-cz, en-de, en-dg, en-dk, en-dm, en-ee, en-eg, en-er, en-es, en-fi, en-fj, en-fk, en-fm, en-fr, en-gb, en-gd, en-gg, en-gh, en-gi, en-gm, en-gs, en-gu, en-gy, en-hk, en-hu, en-id, en-ie, en-il, en-im, en-in, en-io, en-it, en-je, en-jm, en-ke, en-ki, en-kn, en-ky, en-lc, en-lr, en-ls, en-lu, en-mg, en-mh, en-mo, en-mp, en-ms, en-mt, en-mu, en-mv, en-mw, en-mx, en-my, en-na, en-nf, en-ng, en-nl, en-no, en-nr, en-nu, en-nz, en-pg, en-ph, en-pk, en-pl, en-pn, en-pr, en-pt, en-pw, en-ro, en-rw, en-sb, en-sc, en-sd, en-se, en-sg, en-sh, en-si, en-sk, en-sl, en-ss, en-sx, en-sz, en-tc, en-th, en-tk, en-tn, en-to, en-tt, en-tv, en-tz, en-ug, en-um, en-us, en-vc, en-vg, en-vi, en-vn, en-vu, en-ws, en-za, en-zm, en-zw, eo, eo-001, es, es-419, es-ar, es-bo, es-br, es-bz, es-cl, es-co, es-cr, es-cu, es-do, es-ea, es-ec, es-es, es-gq, es-gt, es-hn, es-ic, es-mx, es-ni, es-pa, es-pe, es-ph, es-pr, es-py, es-sv, es-us, es-uy, es-ve, et, et-ee, eu, eu-es, ewo, ewo-cm, fa, fa-af, fa-ir, ff, ff-bf, ff-cm, ff-gh, ff-gm, ff-gn, ff-gw, ff-lr, ff-mr, ff-ne, ff-ng, ff-sl, ff-sn, fi, fi-fi, fil, fil-ph, fj, fo, fo-dk, fo-fo, fr, fr-be, fr-bf, fr-bi, fr-bj, fr-bl, fr-ca, fr-cd, fr-cf, fr-cg, fr-ch, fr-ci, fr-cm, fr-dj, fr-dz, fr-fr, fr-ga, fr-gf, fr-gn, fr-gp, fr-gq, fr-ht, fr-km, fr-lu, fr-ma, fr-mc, fr-mf, fr-mg, fr-ml, fr-mq, fr-mr, fr-mu, fr-nc, fr-ne, fr-pf, fr-pm, fr-re, fr-rw, fr-sc, fr-sn, fr-sy, fr-td, fr-tg, fr-tn, fr-vu, fr-wf, fr-yt, frr, frr-de, fur, fur-it, fy, fy-nl, ga, ga-gb, ga-ie, gaa, gaa-gh, gd, gd-gb, gl, gl-es, gn, gsw, gsw-ch, gsw-fr, gsw-li, gu, gu-in, guz, guz-ke, gv, gv-im, ha, ha-gh, ha-ne, ha-ng, haw, haw-us, he, he-il, hi, hi-in, hmn, ho, hr, hr-ba, hr-hr, hsb, hsb-de, ht, ht-ht, hu, hu-hu, hy, hy-am, hz, ia, ia-001, id, id-id, ie, ie-ee, ig, ig-ng, ii, ii-cn, ik, io, is, is-is, it, it-ch, it-it, it-sm, it-va, iu, ja, ja-jp, jgo, jgo-cm, jmc, jmc-tz, jv, jv-id, ka, ka-ge, kab, kab-dz, kam, kam-ke, kar, kde, kde-tz, kea, kea-cv, kg, kgp, kgp-br, kh, khq, khq-ml, ki, ki-ke, kj, kk, kk-kz, kkj, kkj-cm, kl, kl-gl, kln, kln-ke, km, km-kh, kn, kn-in, ko, ko-cn, ko-kp, ko-kr, kok, kok-in, kr, ks, ks-in, ksb, ksb-tz, ksf, ksf-cm, ksh, ksh-de, ku, ku-tr, kv, kw, kw-gb, kxv, kxv-in, ky, ky-kg, la, lag, lag-tz, lb, lb-lu, lg, lg-ug, li, lij, lij-it, lkt, lkt-us, lmo, lmo-it, ln, ln-ao, ln-cd, ln-cf, ln-cg, lo, lo-la, lrc, lrc-iq, lrc-ir, lt, lt-lt, lu, lu-cd, luo, luo-ke, luy, luy-ke, lv, lv-lv, mai, mai-in, mas, mas-ke, mas-tz, mdf, mdf-ru, mer, mer-ke, mfe, mfe-mu, mg, mg-mg, mgh, mgh-mz, mgo, mgo-cm, mh, mi, mi-nz, mk, mk-mk, ml, ml-in, mn, mn-mn, mni, mni-in, mr, mr-in, ms, ms-bn, ms-id, ms-my, ms-sg, mt, mt-mt, mua, mua-cm, my, my-mm, mzn, mzn-ir, na, naq, naq-na, nb, nb-no, nb-sj, nd, nd-zw, nds, nds-de, nds-nl, ne, ne-in, ne-np, ng, nl, nl-aw, nl-be, nl-bq, nl-ch, nl-cw, nl-lu, nl-nl, nl-sr, nl-sx, nmg, nmg-cm, nn, nn-no, nnh, nnh-cm, no, no-no, nqo, nqo-gn, nr, nso, nso-za, nus, nus-ss, nv, ny, nyn, nyn-ug, oc, oc-es, oc-fr, oj, om, om-et, om-ke, or, or-in, os, os-ge, os-ru, pa, pa-in, pa-pk, pcm, pcm-ng, pi, pis, pis-sb, pl, pl-pl, prg, prg-001, ps, ps-af, ps-pk, pt, pt-ao, pt-br, pt-ch, pt-cv, pt-gq, pt-gw, pt-lu, pt-mo, pt-mz, pt-pt, pt-st, pt-tl, qu, qu-bo, qu-ec, qu-pe, raj, raj-in, rm, rm-ch, rn, rn-bi, ro, ro-md, ro-ro, rof, rof-tz, ru, ru-by, ru-kg, ru-kz, ru-md, ru-ru, ru-ua, rw, rw-rw, rwk, rwk-tz, sa, sa-in, sah, sah-ru, saq, saq-ke, sat, sat-in, sbp, sbp-tz, sc, sc-it, sd, sd-in, sd-pk, se, se-fi, se-no, se-se, seh, seh-mz, ses, ses-ml, sg, sg-cf, shi, shi-ma, si, si-lk, sk, sk-sk, sl, sl-si, sm, smn, smn-fi, sms, sms-fi, sn, sn-zw, so, so-dj, so-et, so-ke, so-so, sq, sq-al, sq-mk, sq-xk, sr, sr-ba, sr-cs, sr-me, sr-rs, sr-xk, ss, st, st-ls, st-za, su, su-id, sv, sv-ax, sv-fi, sv-se, sw, sw-cd, sw-ke, sw-tz, sw-ug, sy, syr, syr-iq, syr-sy, szl, szl-pl, ta, ta-in, ta-lk, ta-my, ta-sg, te, te-in, teo, teo-ke, teo-ug, tg, tg-tj, th, th-th, ti, ti-er, ti-et, tk, tk-tm, tl, tn, tn-bw, tn-za, to, to-to, tok, tok-001, tr, tr-cy, tr-tr, ts, tt, tt-ru, tw, twq, twq-ne, ty, tzm, tzm-ma, ug, ug-cn, uk, uk-ua, ur, ur-in, ur-pk, uz, uz-af, uz-uz, vai, vai-lr, ve, vec, vec-it, vi, vi-vn, vmw, vmw-mz, vo, vo-001, vun, vun-tz, wa, wae, wae-ch, wo, wo-sn, xh, xh-za, xnr, xnr-in, xog, xog-ug, yav, yav-cm, yi, yi-001, yi-ua, yo, yo-bj, yo-ng, yrl, yrl-br, yrl-co, yrl-ve, yue, yue-cn, yue-hk, yue-mo, za, za-cn, zgh, zgh-ma, zh, zh-cn, zh-hans, zh-hant, zh-hk, zh-mo, zh-my, zh-sg, zh-tw, zu, zu-za
name	string	Optional	The name of the email, as displayed on the email dashboard.
publishDate	string	Optional	The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails. Format: date-time
rssData	Model	Optional	Expand Create Email — request body — body rss Data
sendOnPublish	boolean	Optional	Determines whether the email will be sent immediately on publish.
state	string	Optional	The email state. One of: AGENT_GENERATED, AUTOMATED, AUTOMATED_AB, AUTOMATED_AB_VARIANT, AUTOMATED_DRAFT, AUTOMATED_DRAFT_AB, AUTOMATED_DRAFT_ABVARIANT, AUTOMATED_FOR_FORM, AUTOMATED_FOR_FORM_BUFFER, AUTOMATED_FOR_FORM_DRAFT, AUTOMATED_FOR_FORM_LEGACY, AUTOMATED_LOSER_ABVARIANT, AUTOMATED_SENDING, BLOG_EMAIL_DRAFT, BLOG_EMAIL_PUBLISHED, DRAFT, DRAFT_AB, DRAFT_AB_VARIANT, ERROR, LOSER_AB_VARIANT, PAGE_STUB, PRE_PROCESSING, PROCESSING, PUBLISHED, PUBLISHED_AB, PUBLISHED_AB_VARIANT, PUBLISHED_OR_SCHEDULED, RSS_TO_EMAIL_DRAFT, RSS_TO_EMAIL_PUBLISHED, SCHEDULED, SCHEDULED_AB, SCHEDULED_OR_PUBLISHED
subcategory	string	Optional	The email subcategory. One of: ab_loser_variant, ab_loser_variant_site_page, ab_master, ab_master_site_page, ab_variant, ab_variant_site_page, automated, automated_ab_master, automated_ab_variant, automated_for_crm, automated_for_custom_survey, automated_for_deal, automated_for_feedback_ces, automated_for_feedback_custom, automated_for_feedback_nps, automated_for_form, automated_for_form_buffer, automated_for_form_draft, automated_for_form_legacy, automated_for_leadflow, automated_for_ticket, batch, blog_article_instance_layout, blog_article_listing, blog_author_detail, blog_email, blog_email_child, case_study, case_study_instance_layout, case_study_listing, discardable_stub, imported_blog_post, kb_404_page, kb_article_instance_layout, kb_listing, kb_search_results, kb_support_form, landing_page, legacy_blog_post, legacy_page, localtime, manage_preferences_email, marketing_single_send_api, membership_email_verification, membership_follow_up, membership_otp_login, membership_password_reset, membership_password_saved, membership_passwordless_auth, membership_registration, membership_registration_follow_up, membership_verification, normal_blog_post, optin_email, optin_followup_email, page_instance_layout, page_stub, performable_landing_page, performable_landing_page_cutover, podcast_instance_layout, podcast_listing, portal_content, resubscribe_confirmation_email, resubscribe_email, rss_to_email, rss_to_email_child, scp_instance_layout_page, scp_static_page, single_send_api, site_page, smtp_token, staged_page, ticket_closed_kickback_email, ticket_opened_kickback_email, ticket_pipeline_automated, UNKNOWN, unsubscribe_confirmation_email, web_interactive
subject	string	Optional	The subject of the email.
subscriptionDetails	Model	Optional	Expand Create Email — response body — subscription Details
testing	Model	Optional	Expand Create Email — request body — body testing
to	Model	Optional	Expand Create Email — response body — to
webversion	Model	Optional	Expand Create Email — response body — webversion

Referenced models: Create Email — response body — from, Create Email — response body — subscription Details, Create Email — response body — to, Create Email — response body — webversion, Create Email — request body — body content, Create Email — request body — body testing, Create Email — request body — body rss Data