{"files":{"SKILL.md":"---\nname: marketing-emails\ndescription: \"Marketing Emails API skill. Use when working with Marketing Emails for marketing. Covers 19 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Marketing Emails\nAPI version: v3\n\n## Auth\nOAuth2 | ApiKey private-app in header\n\n## Base URL\nhttps://api.hubapi.com\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /marketing/v3/emails -- verify access\n3. POST /marketing/v3/emails -- create first email\n\n## Endpoints\n19 endpoints across 1 group. See references/api-spec.lap for full details.\n\n### Marketing\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /marketing/v3/emails |  |\n| POST | /marketing/v3/emails |  |\n| POST | /marketing/v3/emails/ab-test/create-variation | Create an A/B test variation of a marketing email |\n| POST | /marketing/v3/emails/clone | Clone a marketing email |\n| GET | /marketing/v3/emails/statistics/histogram | Get aggregated statistic intervals |\n| GET | /marketing/v3/emails/statistics/list | Get aggregated statistics |\n| GET | /marketing/v3/emails/{emailId} | Get the details of a specified marketing email |\n| DELETE | /marketing/v3/emails/{emailId} | Delete a marketing email |\n| PATCH | /marketing/v3/emails/{emailId} | Update a marketing email |\n| GET | /marketing/v3/emails/{emailId}/ab-test/get-variation | Get the variation of a an A/B marketing email |\n| GET | /marketing/v3/emails/{emailId}/draft | Get draft version of a marketing email |\n| PATCH | /marketing/v3/emails/{emailId}/draft | Create or update draft version |\n| POST | /marketing/v3/emails/{emailId}/draft/reset | Reset the draft version |\n| POST | /marketing/v3/emails/{emailId}/publish | Publish or send a marketing email |\n| GET | /marketing/v3/emails/{emailId}/revisions | Get revisions of a marketing email |\n| GET | /marketing/v3/emails/{emailId}/revisions/{revisionId} | Get a revision of a marketing email |\n| POST | /marketing/v3/emails/{emailId}/revisions/{revisionId}/restore | Restore a revision of a marketing email |\n| POST | /marketing/v3/emails/{emailId}/revisions/{revisionId}/restore-to-draft | Restore a revision of a marketing email to DRAFT state |\n| POST | /marketing/v3/emails/{emailId}/unpublish | Unpublish or cancel a marketing email |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all emails?\" -> GET /marketing/v3/emails\n- \"Create a email?\" -> POST /marketing/v3/emails\n- \"Create a create-variation?\" -> POST /marketing/v3/emails/ab-test/create-variation\n- \"Create a clone?\" -> POST /marketing/v3/emails/clone\n- \"List all histogram?\" -> GET /marketing/v3/emails/statistics/histogram\n- \"List all list?\" -> GET /marketing/v3/emails/statistics/list\n- \"Get email details?\" -> GET /marketing/v3/emails/{emailId}\n- \"Delete a email?\" -> DELETE /marketing/v3/emails/{emailId}\n- \"Partially update a email?\" -> PATCH /marketing/v3/emails/{emailId}\n- \"List all get-variation?\" -> GET /marketing/v3/emails/{emailId}/ab-test/get-variation\n- \"List all draft?\" -> GET /marketing/v3/emails/{emailId}/draft\n- \"Create a reset?\" -> POST /marketing/v3/emails/{emailId}/draft/reset\n- \"Create a publish?\" -> POST /marketing/v3/emails/{emailId}/publish\n- \"List all revisions?\" -> GET /marketing/v3/emails/{emailId}/revisions\n- \"Get revision details?\" -> GET /marketing/v3/emails/{emailId}/revisions/{revisionId}\n- \"Create a restore?\" -> POST /marketing/v3/emails/{emailId}/revisions/{revisionId}/restore\n- \"Create a restore-to-draft?\" -> POST /marketing/v3/emails/{emailId}/revisions/{revisionId}/restore-to-draft\n- \"Create a unpublish?\" -> POST /marketing/v3/emails/{emailId}/unpublish\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Marketing Emails\n@base https://api.hubapi.com\n@version v3\n@auth OAuth2 | ApiKey private-app in header\n@endpoints 19\n@toc marketing(19)\n\n@endpoint GET /marketing/v3/emails\n@optional {after: str # The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results., archived: bool # Whether to return only results that have been archived., campaign: str, createdAfter: str(date-time), createdAt: str(date-time), createdBefore: str(date-time), includedProperties: [str], includeStats: bool, isPublished: bool, limit: int(int32) # The maximum number of results to display per page., marketingCampaignNames: bool, publishedAfter: str(date-time), publishedAt: str(date-time), publishedBefore: str(date-time), sort: [str], type: str(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), updatedAfter: str(date-time), updatedAt: str(date-time), updatedBefore: str(date-time), variantStats: bool, workflowNames: bool}\n@returns(200) {paging: map{next: map{after: str, link: str}, prev: map{before: str, link: str}}, results: [map], total: int(int32)} # successful operation\n\n@endpoint POST /marketing/v3/emails\n@required {name: str # The name of the email, as displayed on the email dashboard.}\n@optional {activeDomain: str # The active domain of the email., archived: bool # Determines if the email is archived or not., businessUnitId: int(int64) # The ID of the business unit associated with the email., campaign: str # The ID of the campaign this email is associated to., content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map} # Data structure representing the content of the email., feedbackSurveyId: str # The ID of the feedback survey linked to the email., folderIdV2: int(int64) # The ID of the folder where the email will be stored., from: map{customReplyTo: str, fromName: str, replyTo: str} # Data structure representing the from fields on the email., jitterSendTime: bool # Determines whether the email send time should be randomized to avoid sending all emails at the exact same time., language: str(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/bas/bas-cm/be/be-by/bem/bem-zm/bez/bez-tz/bg/bg-bg/bgc/bgc-in/bho/bho-in/bi/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/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-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-gu/en-gy/en-hk/en-id/en-ie/en-il/en-im/en-in/en-io/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-nr/en-nu/en-nz/en-pg/en-ph/en-pk/en-pn/en-pr/en-pt/en-pw/en-rw/en-sb/en-sc/en-sd/en-se/en-sg/en-sh/en-si/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/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/hu/hu-hu/hy/hy-am/hz/ia/ia-001/id/id-id/ie/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-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/ky/ky-kg/la/lag/lag-tz/lb/lb-lu/lg/lg-ug/li/lkt/lkt-us/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/nr/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/su/su-id/sv/sv-ax/sv-fi/sv-se/sw/sw-cd/sw-ke/sw-tz/sw-ug/sy/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/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/vi/vi-vn/vo/vo-001/vun/vun-tz/wa/wae/wae-ch/wo/wo-sn/xh/xh-za/xog/xog-ug/yav/yav-cm/yi/yi-001/yo/yo-bj/yo-ng/yrl/yrl-br/yrl-co/yrl-ve/yue/yue-cn/yue-hk/za/zgh/zgh-ma/zh/zh-cn/zh-hans/zh-hant/zh-hk/zh-mo/zh-sg/zh-tw/zu/zu-za) # The language code for the email, such as 'en' for English., publishDate: str(date-time) # The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails., rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool} # RSS related data if it is a blog or rss email., sendOnPublish: bool # Determines whether the email will be sent immediately on publish., state: str(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) # The email state., subcategory: str(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) # The email subcategory., subject: str # The subject of the email., subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str} # Data structure representing the subscription fields of the email., testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str} # AB testing related data. This property is only returned for AB type emails., to: map{contactIds: map, contactIlsLists: map, contactLists: map, limitSendFrequency: bool, suppressGraymail: bool} # Data structure representing the to fields of the email., webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}}\n@returns(201) {activeDomain: str, allEmailCampaignIds: [str], archived: bool, businessUnitId: str, campaign: str, campaignName: str, campaignUtm: str, clonedFrom: str, content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map{backgroundColor: str, backgroundImage: str, backgroundImageType: str, bodyBorderColor: str, bodyBorderColorChoice: str, bodyBorderWidth: num, bodyColor: str, buttonStyleSettings: map{backgroundColor: map, cornerRadius: int(int32), fontStyle: map}, colorPickerFavorite1: str, colorPickerFavorite2: str, colorPickerFavorite3: str, colorPickerFavorite4: str, colorPickerFavorite5: str, colorPickerFavorite6: str, dividerStyleSettings: map{color: map, height: int(int32), lineType: str}, emailBodyPadding: str, emailBodyWidth: str, headingOneFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, headingTwoFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, linksFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, primaryAccentColor: str, primaryFont: str, primaryFontColor: str, primaryFontLineHeight: str, primaryFontSize: num, secondaryAccentColor: str, secondaryFont: str, secondaryFontColor: str, secondaryFontLineHeight: str, secondaryFontSize: num}, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map}, createdAt: str(date-time), createdById: str, deletedAt: str(date-time), emailCampaignGroupId: str, emailTemplateMode: str, feedbackSurveyId: str, folderId: int(int64), folderIdV2: int(int64), from: map{customReplyTo: str, fromName: str, replyTo: str}, id: str, isAb: bool, isPublished: bool, isTransactional: bool, jitterSendTime: bool, language: str, name: str, previewKey: str, primaryEmailCampaignId: str, publishDate: str(date-time), publishedAt: str(date-time), publishedByEmail: str, publishedById: str, publishedByName: str, rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool}, sendOnPublish: bool, state: str, stats: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, subcategory: str, subject: str, subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str}, teamsWithAccess: [str], testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str}, to: map{contactIds: map{exclude: [str], include: [str]}, contactIlsLists: map{exclude: [str], include: [str]}, contactLists: map{exclude: [str], include: [str]}, limitSendFrequency: bool, suppressGraymail: bool}, type: str, unpublishedAt: str(date-time), updatedAt: str(date-time), updatedById: str, usersWithAccess: [str], webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}, workflowNames: [str]} # successful operation\n\n@endpoint POST /marketing/v3/emails/ab-test/create-variation\n@desc Create an A/B test variation of a marketing email\n@required {contentId: str # ID of the object to test., variationName: str # Name of the variation to be created.}\n@returns(201) {activeDomain: str, allEmailCampaignIds: [str], archived: bool, businessUnitId: str, campaign: str, campaignName: str, campaignUtm: str, clonedFrom: str, content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map{backgroundColor: str, backgroundImage: str, backgroundImageType: str, bodyBorderColor: str, bodyBorderColorChoice: str, bodyBorderWidth: num, bodyColor: str, buttonStyleSettings: map{backgroundColor: map, cornerRadius: int(int32), fontStyle: map}, colorPickerFavorite1: str, colorPickerFavorite2: str, colorPickerFavorite3: str, colorPickerFavorite4: str, colorPickerFavorite5: str, colorPickerFavorite6: str, dividerStyleSettings: map{color: map, height: int(int32), lineType: str}, emailBodyPadding: str, emailBodyWidth: str, headingOneFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, headingTwoFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, linksFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, primaryAccentColor: str, primaryFont: str, primaryFontColor: str, primaryFontLineHeight: str, primaryFontSize: num, secondaryAccentColor: str, secondaryFont: str, secondaryFontColor: str, secondaryFontLineHeight: str, secondaryFontSize: num}, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map}, createdAt: str(date-time), createdById: str, deletedAt: str(date-time), emailCampaignGroupId: str, emailTemplateMode: str, feedbackSurveyId: str, folderId: int(int64), folderIdV2: int(int64), from: map{customReplyTo: str, fromName: str, replyTo: str}, id: str, isAb: bool, isPublished: bool, isTransactional: bool, jitterSendTime: bool, language: str, name: str, previewKey: str, primaryEmailCampaignId: str, publishDate: str(date-time), publishedAt: str(date-time), publishedByEmail: str, publishedById: str, publishedByName: str, rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool}, sendOnPublish: bool, state: str, stats: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, subcategory: str, subject: str, subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str}, teamsWithAccess: [str], testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str}, to: map{contactIds: map{exclude: [str], include: [str]}, contactIlsLists: map{exclude: [str], include: [str]}, contactLists: map{exclude: [str], include: [str]}, limitSendFrequency: bool, suppressGraymail: bool}, type: str, unpublishedAt: str(date-time), updatedAt: str(date-time), updatedById: str, usersWithAccess: [str], webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}, workflowNames: [str]} # successful operation\n\n@endpoint POST /marketing/v3/emails/clone\n@desc Clone a marketing email\n@required {id: str # The email ID.}\n@optional {cloneName: str # The name to assign to the cloned email., language: str # The language code for the cloned email, such as 'en' for English.}\n@returns(200) {activeDomain: str, allEmailCampaignIds: [str], archived: bool, businessUnitId: str, campaign: str, campaignName: str, campaignUtm: str, clonedFrom: str, content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map{backgroundColor: str, backgroundImage: str, backgroundImageType: str, bodyBorderColor: str, bodyBorderColorChoice: str, bodyBorderWidth: num, bodyColor: str, buttonStyleSettings: map{backgroundColor: map, cornerRadius: int(int32), fontStyle: map}, colorPickerFavorite1: str, colorPickerFavorite2: str, colorPickerFavorite3: str, colorPickerFavorite4: str, colorPickerFavorite5: str, colorPickerFavorite6: str, dividerStyleSettings: map{color: map, height: int(int32), lineType: str}, emailBodyPadding: str, emailBodyWidth: str, headingOneFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, headingTwoFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, linksFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, primaryAccentColor: str, primaryFont: str, primaryFontColor: str, primaryFontLineHeight: str, primaryFontSize: num, secondaryAccentColor: str, secondaryFont: str, secondaryFontColor: str, secondaryFontLineHeight: str, secondaryFontSize: num}, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map}, createdAt: str(date-time), createdById: str, deletedAt: str(date-time), emailCampaignGroupId: str, emailTemplateMode: str, feedbackSurveyId: str, folderId: int(int64), folderIdV2: int(int64), from: map{customReplyTo: str, fromName: str, replyTo: str}, id: str, isAb: bool, isPublished: bool, isTransactional: bool, jitterSendTime: bool, language: str, name: str, previewKey: str, primaryEmailCampaignId: str, publishDate: str(date-time), publishedAt: str(date-time), publishedByEmail: str, publishedById: str, publishedByName: str, rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool}, sendOnPublish: bool, state: str, stats: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, subcategory: str, subject: str, subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str}, teamsWithAccess: [str], testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str}, to: map{contactIds: map{exclude: [str], include: [str]}, contactIlsLists: map{exclude: [str], include: [str]}, contactLists: map{exclude: [str], include: [str]}, limitSendFrequency: bool, suppressGraymail: bool}, type: str, unpublishedAt: str(date-time), updatedAt: str(date-time), updatedById: str, usersWithAccess: [str], webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}, workflowNames: [str]} # successful operation\n\n@endpoint GET /marketing/v3/emails/statistics/histogram\n@desc Get aggregated statistic intervals\n@optional {emailIds: [int(int64)], endTimestamp: str, interval: str(DAY/HOUR/MINUTE/MONTH/QUARTER/QUARTER_HOUR/SECOND/WEEK/YEAR), startTimestamp: str}\n@returns(200) {paging: map{next: map{after: str, link: str}, prev: map{before: str, link: str}}, results: [map], total: int(int32)} # successful operation\n\n@endpoint GET /marketing/v3/emails/statistics/list\n@desc Get aggregated statistics\n@optional {emailIds: [int(int64)], endTimestamp: str, property: str, startTimestamp: str}\n@returns(200) {aggregate: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, campaignAggregations: map, emails: [int(int64)]} # successful operation\n\n@endpoint GET /marketing/v3/emails/{emailId}\n@desc Get the details of a specified marketing email\n@required {emailId: str}\n@optional {archived: bool # Whether to return only results that have been archived., includedProperties: [str], includeStats: bool, marketingCampaignNames: bool, variantStats: bool, workflowNames: bool}\n@returns(200) {activeDomain: str, allEmailCampaignIds: [str], archived: bool, businessUnitId: str, campaign: str, campaignName: str, campaignUtm: str, clonedFrom: str, content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map{backgroundColor: str, backgroundImage: str, backgroundImageType: str, bodyBorderColor: str, bodyBorderColorChoice: str, bodyBorderWidth: num, bodyColor: str, buttonStyleSettings: map{backgroundColor: map, cornerRadius: int(int32), fontStyle: map}, colorPickerFavorite1: str, colorPickerFavorite2: str, colorPickerFavorite3: str, colorPickerFavorite4: str, colorPickerFavorite5: str, colorPickerFavorite6: str, dividerStyleSettings: map{color: map, height: int(int32), lineType: str}, emailBodyPadding: str, emailBodyWidth: str, headingOneFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, headingTwoFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, linksFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, primaryAccentColor: str, primaryFont: str, primaryFontColor: str, primaryFontLineHeight: str, primaryFontSize: num, secondaryAccentColor: str, secondaryFont: str, secondaryFontColor: str, secondaryFontLineHeight: str, secondaryFontSize: num}, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map}, createdAt: str(date-time), createdById: str, deletedAt: str(date-time), emailCampaignGroupId: str, emailTemplateMode: str, feedbackSurveyId: str, folderId: int(int64), folderIdV2: int(int64), from: map{customReplyTo: str, fromName: str, replyTo: str}, id: str, isAb: bool, isPublished: bool, isTransactional: bool, jitterSendTime: bool, language: str, name: str, previewKey: str, primaryEmailCampaignId: str, publishDate: str(date-time), publishedAt: str(date-time), publishedByEmail: str, publishedById: str, publishedByName: str, rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool}, sendOnPublish: bool, state: str, stats: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, subcategory: str, subject: str, subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str}, teamsWithAccess: [str], testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str}, to: map{contactIds: map{exclude: [str], include: [str]}, contactIlsLists: map{exclude: [str], include: [str]}, contactLists: map{exclude: [str], include: [str]}, limitSendFrequency: bool, suppressGraymail: bool}, type: str, unpublishedAt: str(date-time), updatedAt: str(date-time), updatedById: str, usersWithAccess: [str], webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}, workflowNames: [str]} # successful operation\n\n@endpoint DELETE /marketing/v3/emails/{emailId}\n@desc Delete a marketing email\n@required {emailId: str}\n@optional {archived: bool # Whether to return only results that have been archived.}\n@returns(204) No content\n\n@endpoint PATCH /marketing/v3/emails/{emailId}\n@desc Update a marketing email\n@required {emailId: str}\n@optional {archived: bool # Whether to return only results that have been archived., activeDomain: str # The active domain of the email., archived: bool # Determines if the email is archived or not., businessUnitId: int(int64) # The ID of the business unit associated with the email., campaign: str # The ID of the campaign this email is associated to., content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map} # Data structure representing the content of the email., folderIdV2: int(int64) # The ID of the folder where the email will be stored., from: map{customReplyTo: str, fromName: str, replyTo: str} # Data structure representing the from fields on the email., jitterSendTime: bool # Determines whether the email send time should be randomized to avoid sending all emails at the exact same time., language: str(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/bas/bas-cm/be/be-by/bem/bem-zm/bez/bez-tz/bg/bg-bg/bgc/bgc-in/bho/bho-in/bi/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/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-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-gu/en-gy/en-hk/en-id/en-ie/en-il/en-im/en-in/en-io/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-nr/en-nu/en-nz/en-pg/en-ph/en-pk/en-pn/en-pr/en-pt/en-pw/en-rw/en-sb/en-sc/en-sd/en-se/en-sg/en-sh/en-si/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/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/hu/hu-hu/hy/hy-am/hz/ia/ia-001/id/id-id/ie/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-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/ky/ky-kg/la/lag/lag-tz/lb/lb-lu/lg/lg-ug/li/lkt/lkt-us/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/nr/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/su/su-id/sv/sv-ax/sv-fi/sv-se/sw/sw-cd/sw-ke/sw-tz/sw-ug/sy/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/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/vi/vi-vn/vo/vo-001/vun/vun-tz/wa/wae/wae-ch/wo/wo-sn/xh/xh-za/xog/xog-ug/yav/yav-cm/yi/yi-001/yo/yo-bj/yo-ng/yrl/yrl-br/yrl-co/yrl-ve/yue/yue-cn/yue-hk/za/zgh/zgh-ma/zh/zh-cn/zh-hans/zh-hant/zh-hk/zh-mo/zh-sg/zh-tw/zu/zu-za) # The language code for the email, such as 'en' for English., name: str # The name of the email, as displayed on the email dashboard., publishDate: str(date-time) # The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails., rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool} # RSS related data if it is a blog or rss email., sendOnPublish: bool # Determines whether the email will be sent immediately on publish., state: str(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) # The email state., subcategory: str(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) # The email subcategory., subject: str # The subject of the email., subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str} # Data structure representing the subscription fields of the email., testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str} # AB testing related data. This property is only returned for AB type emails., to: map{contactIds: map, contactIlsLists: map, contactLists: map, limitSendFrequency: bool, suppressGraymail: bool} # Data structure representing the to fields of the email., webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}}\n@returns(200) {activeDomain: str, allEmailCampaignIds: [str], archived: bool, businessUnitId: str, campaign: str, campaignName: str, campaignUtm: str, clonedFrom: str, content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map{backgroundColor: str, backgroundImage: str, backgroundImageType: str, bodyBorderColor: str, bodyBorderColorChoice: str, bodyBorderWidth: num, bodyColor: str, buttonStyleSettings: map{backgroundColor: map, cornerRadius: int(int32), fontStyle: map}, colorPickerFavorite1: str, colorPickerFavorite2: str, colorPickerFavorite3: str, colorPickerFavorite4: str, colorPickerFavorite5: str, colorPickerFavorite6: str, dividerStyleSettings: map{color: map, height: int(int32), lineType: str}, emailBodyPadding: str, emailBodyWidth: str, headingOneFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, headingTwoFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, linksFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, primaryAccentColor: str, primaryFont: str, primaryFontColor: str, primaryFontLineHeight: str, primaryFontSize: num, secondaryAccentColor: str, secondaryFont: str, secondaryFontColor: str, secondaryFontLineHeight: str, secondaryFontSize: num}, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map}, createdAt: str(date-time), createdById: str, deletedAt: str(date-time), emailCampaignGroupId: str, emailTemplateMode: str, feedbackSurveyId: str, folderId: int(int64), folderIdV2: int(int64), from: map{customReplyTo: str, fromName: str, replyTo: str}, id: str, isAb: bool, isPublished: bool, isTransactional: bool, jitterSendTime: bool, language: str, name: str, previewKey: str, primaryEmailCampaignId: str, publishDate: str(date-time), publishedAt: str(date-time), publishedByEmail: str, publishedById: str, publishedByName: str, rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool}, sendOnPublish: bool, state: str, stats: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, subcategory: str, subject: str, subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str}, teamsWithAccess: [str], testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str}, to: map{contactIds: map{exclude: [str], include: [str]}, contactIlsLists: map{exclude: [str], include: [str]}, contactLists: map{exclude: [str], include: [str]}, limitSendFrequency: bool, suppressGraymail: bool}, type: str, unpublishedAt: str(date-time), updatedAt: str(date-time), updatedById: str, usersWithAccess: [str], webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}, workflowNames: [str]} # successful operation\n\n@endpoint GET /marketing/v3/emails/{emailId}/ab-test/get-variation\n@desc Get the variation of a an A/B marketing email\n@required {emailId: str}\n@optional {archived: bool # Whether to return only results that have been archived., includedProperties: [str], includeStats: bool, marketingCampaignNames: bool, variantStats: bool, workflowNames: bool}\n@returns(200) {activeDomain: str, allEmailCampaignIds: [str], archived: bool, businessUnitId: str, campaign: str, campaignName: str, campaignUtm: str, clonedFrom: str, content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map{backgroundColor: str, backgroundImage: str, backgroundImageType: str, bodyBorderColor: str, bodyBorderColorChoice: str, bodyBorderWidth: num, bodyColor: str, buttonStyleSettings: map{backgroundColor: map, cornerRadius: int(int32), fontStyle: map}, colorPickerFavorite1: str, colorPickerFavorite2: str, colorPickerFavorite3: str, colorPickerFavorite4: str, colorPickerFavorite5: str, colorPickerFavorite6: str, dividerStyleSettings: map{color: map, height: int(int32), lineType: str}, emailBodyPadding: str, emailBodyWidth: str, headingOneFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, headingTwoFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, linksFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, primaryAccentColor: str, primaryFont: str, primaryFontColor: str, primaryFontLineHeight: str, primaryFontSize: num, secondaryAccentColor: str, secondaryFont: str, secondaryFontColor: str, secondaryFontLineHeight: str, secondaryFontSize: num}, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map}, createdAt: str(date-time), createdById: str, deletedAt: str(date-time), emailCampaignGroupId: str, emailTemplateMode: str, feedbackSurveyId: str, folderId: int(int64), folderIdV2: int(int64), from: map{customReplyTo: str, fromName: str, replyTo: str}, id: str, isAb: bool, isPublished: bool, isTransactional: bool, jitterSendTime: bool, language: str, name: str, previewKey: str, primaryEmailCampaignId: str, publishDate: str(date-time), publishedAt: str(date-time), publishedByEmail: str, publishedById: str, publishedByName: str, rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool}, sendOnPublish: bool, state: str, stats: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, subcategory: str, subject: str, subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str}, teamsWithAccess: [str], testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str}, to: map{contactIds: map{exclude: [str], include: [str]}, contactIlsLists: map{exclude: [str], include: [str]}, contactLists: map{exclude: [str], include: [str]}, limitSendFrequency: bool, suppressGraymail: bool}, type: str, unpublishedAt: str(date-time), updatedAt: str(date-time), updatedById: str, usersWithAccess: [str], webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}, workflowNames: [str]} # successful operation\n\n@endpoint GET /marketing/v3/emails/{emailId}/draft\n@desc Get draft version of a marketing email\n@required {emailId: str}\n@returns(200) {activeDomain: str, allEmailCampaignIds: [str], archived: bool, businessUnitId: str, campaign: str, campaignName: str, campaignUtm: str, clonedFrom: str, content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map{backgroundColor: str, backgroundImage: str, backgroundImageType: str, bodyBorderColor: str, bodyBorderColorChoice: str, bodyBorderWidth: num, bodyColor: str, buttonStyleSettings: map{backgroundColor: map, cornerRadius: int(int32), fontStyle: map}, colorPickerFavorite1: str, colorPickerFavorite2: str, colorPickerFavorite3: str, colorPickerFavorite4: str, colorPickerFavorite5: str, colorPickerFavorite6: str, dividerStyleSettings: map{color: map, height: int(int32), lineType: str}, emailBodyPadding: str, emailBodyWidth: str, headingOneFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, headingTwoFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, linksFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, primaryAccentColor: str, primaryFont: str, primaryFontColor: str, primaryFontLineHeight: str, primaryFontSize: num, secondaryAccentColor: str, secondaryFont: str, secondaryFontColor: str, secondaryFontLineHeight: str, secondaryFontSize: num}, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map}, createdAt: str(date-time), createdById: str, deletedAt: str(date-time), emailCampaignGroupId: str, emailTemplateMode: str, feedbackSurveyId: str, folderId: int(int64), folderIdV2: int(int64), from: map{customReplyTo: str, fromName: str, replyTo: str}, id: str, isAb: bool, isPublished: bool, isTransactional: bool, jitterSendTime: bool, language: str, name: str, previewKey: str, primaryEmailCampaignId: str, publishDate: str(date-time), publishedAt: str(date-time), publishedByEmail: str, publishedById: str, publishedByName: str, rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool}, sendOnPublish: bool, state: str, stats: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, subcategory: str, subject: str, subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str}, teamsWithAccess: [str], testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str}, to: map{contactIds: map{exclude: [str], include: [str]}, contactIlsLists: map{exclude: [str], include: [str]}, contactLists: map{exclude: [str], include: [str]}, limitSendFrequency: bool, suppressGraymail: bool}, type: str, unpublishedAt: str(date-time), updatedAt: str(date-time), updatedById: str, usersWithAccess: [str], webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}, workflowNames: [str]} # successful operation\n\n@endpoint PATCH /marketing/v3/emails/{emailId}/draft\n@desc Create or update draft version\n@required {emailId: str}\n@optional {activeDomain: str # The active domain of the email., archived: bool # Determines if the email is archived or not., businessUnitId: int(int64) # The ID of the business unit associated with the email., campaign: str # The ID of the campaign this email is associated to., content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map} # Data structure representing the content of the email., folderIdV2: int(int64) # The ID of the folder where the email will be stored., from: map{customReplyTo: str, fromName: str, replyTo: str} # Data structure representing the from fields on the email., jitterSendTime: bool # Determines whether the email send time should be randomized to avoid sending all emails at the exact same time., language: str(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/bas/bas-cm/be/be-by/bem/bem-zm/bez/bez-tz/bg/bg-bg/bgc/bgc-in/bho/bho-in/bi/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/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-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-gu/en-gy/en-hk/en-id/en-ie/en-il/en-im/en-in/en-io/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-nr/en-nu/en-nz/en-pg/en-ph/en-pk/en-pn/en-pr/en-pt/en-pw/en-rw/en-sb/en-sc/en-sd/en-se/en-sg/en-sh/en-si/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/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/hu/hu-hu/hy/hy-am/hz/ia/ia-001/id/id-id/ie/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-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/ky/ky-kg/la/lag/lag-tz/lb/lb-lu/lg/lg-ug/li/lkt/lkt-us/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/nr/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/su/su-id/sv/sv-ax/sv-fi/sv-se/sw/sw-cd/sw-ke/sw-tz/sw-ug/sy/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/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/vi/vi-vn/vo/vo-001/vun/vun-tz/wa/wae/wae-ch/wo/wo-sn/xh/xh-za/xog/xog-ug/yav/yav-cm/yi/yi-001/yo/yo-bj/yo-ng/yrl/yrl-br/yrl-co/yrl-ve/yue/yue-cn/yue-hk/za/zgh/zgh-ma/zh/zh-cn/zh-hans/zh-hant/zh-hk/zh-mo/zh-sg/zh-tw/zu/zu-za) # The language code for the email, such as 'en' for English., name: str # The name of the email, as displayed on the email dashboard., publishDate: str(date-time) # The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails., rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool} # RSS related data if it is a blog or rss email., sendOnPublish: bool # Determines whether the email will be sent immediately on publish., state: str(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) # The email state., subcategory: str(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) # The email subcategory., subject: str # The subject of the email., subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str} # Data structure representing the subscription fields of the email., testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str} # AB testing related data. This property is only returned for AB type emails., to: map{contactIds: map, contactIlsLists: map, contactLists: map, limitSendFrequency: bool, suppressGraymail: bool} # Data structure representing the to fields of the email., webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}}\n@returns(200) {activeDomain: str, allEmailCampaignIds: [str], archived: bool, businessUnitId: str, campaign: str, campaignName: str, campaignUtm: str, clonedFrom: str, content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map{backgroundColor: str, backgroundImage: str, backgroundImageType: str, bodyBorderColor: str, bodyBorderColorChoice: str, bodyBorderWidth: num, bodyColor: str, buttonStyleSettings: map{backgroundColor: map, cornerRadius: int(int32), fontStyle: map}, colorPickerFavorite1: str, colorPickerFavorite2: str, colorPickerFavorite3: str, colorPickerFavorite4: str, colorPickerFavorite5: str, colorPickerFavorite6: str, dividerStyleSettings: map{color: map, height: int(int32), lineType: str}, emailBodyPadding: str, emailBodyWidth: str, headingOneFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, headingTwoFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, linksFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, primaryAccentColor: str, primaryFont: str, primaryFontColor: str, primaryFontLineHeight: str, primaryFontSize: num, secondaryAccentColor: str, secondaryFont: str, secondaryFontColor: str, secondaryFontLineHeight: str, secondaryFontSize: num}, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map}, createdAt: str(date-time), createdById: str, deletedAt: str(date-time), emailCampaignGroupId: str, emailTemplateMode: str, feedbackSurveyId: str, folderId: int(int64), folderIdV2: int(int64), from: map{customReplyTo: str, fromName: str, replyTo: str}, id: str, isAb: bool, isPublished: bool, isTransactional: bool, jitterSendTime: bool, language: str, name: str, previewKey: str, primaryEmailCampaignId: str, publishDate: str(date-time), publishedAt: str(date-time), publishedByEmail: str, publishedById: str, publishedByName: str, rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool}, sendOnPublish: bool, state: str, stats: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, subcategory: str, subject: str, subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str}, teamsWithAccess: [str], testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str}, to: map{contactIds: map{exclude: [str], include: [str]}, contactIlsLists: map{exclude: [str], include: [str]}, contactLists: map{exclude: [str], include: [str]}, limitSendFrequency: bool, suppressGraymail: bool}, type: str, unpublishedAt: str(date-time), updatedAt: str(date-time), updatedById: str, usersWithAccess: [str], webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}, workflowNames: [str]} # successful operation\n\n@endpoint POST /marketing/v3/emails/{emailId}/draft/reset\n@desc Reset the draft version\n@required {emailId: str}\n@returns(204) No content\n\n@endpoint POST /marketing/v3/emails/{emailId}/publish\n@desc Publish or send a marketing email\n@required {emailId: str}\n@returns(204) No content\n\n@endpoint GET /marketing/v3/emails/{emailId}/revisions\n@desc Get revisions of a marketing email\n@required {emailId: str}\n@optional {after: str # The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results., before: str, limit: int(int32) # The maximum number of results to display per page.}\n@returns(200) {paging: map{next: map{after: str, link: str}, prev: map{before: str, link: str}}, results: [map], total: int(int32)} # successful operation\n\n@endpoint GET /marketing/v3/emails/{emailId}/revisions/{revisionId}\n@desc Get a revision of a marketing email\n@required {emailId: str, revisionId: str}\n@returns(200) {id: str, object: map{activeDomain: str, allEmailCampaignIds: [str], archived: bool, businessUnitId: str, campaign: str, campaignName: str, campaignUtm: str, clonedFrom: str, content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map{backgroundColor: str, backgroundImage: str, backgroundImageType: str, bodyBorderColor: str, bodyBorderColorChoice: str, bodyBorderWidth: num, bodyColor: str, buttonStyleSettings: map, colorPickerFavorite1: str, colorPickerFavorite2: str, colorPickerFavorite3: str, colorPickerFavorite4: str, colorPickerFavorite5: str, colorPickerFavorite6: str, dividerStyleSettings: map, emailBodyPadding: str, emailBodyWidth: str, headingOneFont: map, headingTwoFont: map, linksFont: map, primaryAccentColor: str, primaryFont: str, primaryFontColor: str, primaryFontLineHeight: str, primaryFontSize: num, secondaryAccentColor: str, secondaryFont: str, secondaryFontColor: str, secondaryFontLineHeight: str, secondaryFontSize: num}, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map}, createdAt: str(date-time), createdById: str, deletedAt: str(date-time), emailCampaignGroupId: str, emailTemplateMode: str, feedbackSurveyId: str, folderId: int(int64), folderIdV2: int(int64), from: map{customReplyTo: str, fromName: str, replyTo: str}, id: str, isAb: bool, isPublished: bool, isTransactional: bool, jitterSendTime: bool, language: str, name: str, previewKey: str, primaryEmailCampaignId: str, publishDate: str(date-time), publishedAt: str(date-time), publishedByEmail: str, publishedById: str, publishedByName: str, rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool}, sendOnPublish: bool, state: str, stats: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, subcategory: str, subject: str, subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str}, teamsWithAccess: [str], testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str}, to: map{contactIds: map{exclude: [str], include: [str]}, contactIlsLists: map{exclude: [str], include: [str]}, contactLists: map{exclude: [str], include: [str]}, limitSendFrequency: bool, suppressGraymail: bool}, type: str, unpublishedAt: str(date-time), updatedAt: str(date-time), updatedById: str, usersWithAccess: [str], webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}, workflowNames: [str]}, updatedAt: str(date-time), user: map{email: str, fullName: str, id: str}} # successful operation\n\n@endpoint POST /marketing/v3/emails/{emailId}/revisions/{revisionId}/restore\n@desc Restore a revision of a marketing email\n@required {emailId: str, revisionId: str}\n@returns(204) No content\n\n@endpoint POST /marketing/v3/emails/{emailId}/revisions/{revisionId}/restore-to-draft\n@desc Restore a revision of a marketing email to DRAFT state\n@required {emailId: str, revisionId: int(int64) # The ID of the revision.}\n@returns(200) {activeDomain: str, allEmailCampaignIds: [str], archived: bool, businessUnitId: str, campaign: str, campaignName: str, campaignUtm: str, clonedFrom: str, content: map{flexAreas: map, plainTextVersion: str, smartFields: map, styleSettings: map{backgroundColor: str, backgroundImage: str, backgroundImageType: str, bodyBorderColor: str, bodyBorderColorChoice: str, bodyBorderWidth: num, bodyColor: str, buttonStyleSettings: map{backgroundColor: map, cornerRadius: int(int32), fontStyle: map}, colorPickerFavorite1: str, colorPickerFavorite2: str, colorPickerFavorite3: str, colorPickerFavorite4: str, colorPickerFavorite5: str, colorPickerFavorite6: str, dividerStyleSettings: map{color: map, height: int(int32), lineType: str}, emailBodyPadding: str, emailBodyWidth: str, headingOneFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, headingTwoFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, linksFont: map{bold: bool, color: str, font: str, italic: bool, size: int(int32), underline: bool}, primaryAccentColor: str, primaryFont: str, primaryFontColor: str, primaryFontLineHeight: str, primaryFontSize: num, secondaryAccentColor: str, secondaryFont: str, secondaryFontColor: str, secondaryFontLineHeight: str, secondaryFontSize: num}, templatePath: str, themeSettingsValues: map, widgetContainers: map, widgets: map}, createdAt: str(date-time), createdById: str, deletedAt: str(date-time), emailCampaignGroupId: str, emailTemplateMode: str, feedbackSurveyId: str, folderId: int(int64), folderIdV2: int(int64), from: map{customReplyTo: str, fromName: str, replyTo: str}, id: str, isAb: bool, isPublished: bool, isTransactional: bool, jitterSendTime: bool, language: str, name: str, previewKey: str, primaryEmailCampaignId: str, publishDate: str(date-time), publishedAt: str(date-time), publishedByEmail: str, publishedById: str, publishedByName: str, rssData: map{blogEmailType: str, blogImageMaxWidth: int(int32), blogLayout: str, hubspotBlogId: str, maxEntries: int(int32), rssEntryTemplate: str, timing: map, url: str, useHeadlineAsSubject: bool}, sendOnPublish: bool, state: str, stats: map{counters: map, deviceBreakdown: map, qualifierStats: map, ratios: map}, subcategory: str, subject: str, subscriptionDetails: map{officeLocationId: str, preferencesGroupId: str, subscriptionId: str, subscriptionName: str}, teamsWithAccess: [str], testing: map{abSampleSizeDefault: str, abSamplingDefault: str, abStatus: str, abSuccessMetric: str, abTestPercentage: int(int32), hoursToWait: int(int32), isAbVariation: bool, testId: str}, to: map{contactIds: map{exclude: [str], include: [str]}, contactIlsLists: map{exclude: [str], include: [str]}, contactLists: map{exclude: [str], include: [str]}, limitSendFrequency: bool, suppressGraymail: bool}, type: str, unpublishedAt: str(date-time), updatedAt: str(date-time), updatedById: str, usersWithAccess: [str], webversion: map{domain: str, enabled: bool, expiresAt: str(date-time), isPageRedirected: bool, metaDescription: str, pageExpiryEnabled: bool, redirectToPageId: str, redirectToUrl: str, slug: str, title: str, url: str}, workflowNames: [str]} # successful operation\n\n@endpoint POST /marketing/v3/emails/{emailId}/unpublish\n@desc Unpublish or cancel a marketing email\n@required {emailId: str}\n@returns(204) No content\n\n@end\n"}}