> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

---
id: 932c24e3-7dea-4ff5-8b40-2b62ea76041e
---

# Update draft

> Create or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned.

export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel}) => {
  const translations = {
    description: "Requires one of the following products or higher.",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub",
      data: "Data Hub",
      commerce: "Revenue Hub"
    },
    tiers: {
      free: "Free",
      starter: "Starter",
      professional: "Professional",
      enterprise: "Enterprise"
    }
  };
  const translateTier = tier => {
    if (!tier) return '';
    const lowerTier = tier.toLowerCase();
    return translations.tiers[lowerTier] || tier;
  };
  const products = [{
    name: marketing ? translations.productNames.marketing : '',
    level: translateTier(marketingLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
    alt: "Content Hub"
  }, {
    name: data ? translations.productNames.data : '',
    level: translateTier(dataLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base_2023-24-25/subscription_key_icons/operations_icon.svg",
    alt: "Data Hub"
  }, {
    name: commerce ? translations.productNames.commerce : '',
    level: translateTier(commerceLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg",
    alt: "Revenue Hub"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="FREE" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'content'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/2026-03/marketing-marketing-emails-v2026-03.json PATCH /marketing/emails/2026-03/{emailId}/draft
openapi: 3.0.1
info:
  title: Marketing Emails
  description: Basepom for all HubSpot Projects
  version: 2026-03
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    You want to programmatically create marketing emails, then retrieve their
    send statistics at a later time.
  x-hubspot-introduction: >-
    Use the marketing email API to create, manage, and retrieve details about
    marketing emails. You can also this use API to retrieve statistics related
    to email sends, similar to what you can see in HubSpot.
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Emails
paths:
  /marketing/emails/2026-03/{emailId}/draft:
    patch:
      tags:
        - Emails
      summary: Create or update draft version
      description: >-
        Create or update the draft version of a marketing email. If no draft
        exists, the system creates a draft from the current “live” email then
        applies the request body to that draft. The draft version only lives on
        the buffer—the email is not cloned.
      operationId: patch-/marketing/emails/2026-03/{emailId}/draft_upsertDraft
      parameters:
        - name: emailId
          in: path
          description: The marketing email ID.
          required: true
          style: simple
          explode: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailUpdateRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicEmail'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - content
components:
  schemas:
    EmailUpdateRequest:
      type: object
      properties:
        activeDomain:
          type: string
          description: The active domain of the email.
        archived:
          type: boolean
          description: Determines if the email is archived or not.
        businessUnitId:
          type: integer
          description: The ID of the business unit associated with the email.
          format: int64
        campaign:
          type: string
          description: The ID of the campaign this email is associated to.
        content:
          $ref: '#/components/schemas/PublicEmailContent'
        folderIdV2:
          type: integer
          description: The ID of the folder where the email will be stored.
          format: int64
        from:
          $ref: '#/components/schemas/PublicEmailFromDetails'
        jitterSendTime:
          type: boolean
          description: >-
            Determines whether the email send time should be randomized to avoid
            sending all emails at the exact same time.
        language:
          type: string
          description: The language code for the email, such as 'en' for English.
          enum:
            - 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:
          type: string
          description: The name of the email, as displayed on the email dashboard.
        publishDate:
          type: string
          description: >-
            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:
          $ref: '#/components/schemas/PublicRssEmailDetails'
        sendOnPublish:
          type: boolean
          description: Determines whether the email will be sent immediately on publish.
        state:
          type: string
          description: The email state.
          enum:
            - 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:
          type: string
          description: The email subcategory.
          enum:
            - 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:
          type: string
          description: The subject of the email.
        subscriptionDetails:
          $ref: '#/components/schemas/PublicEmailSubscriptionDetails'
        testing:
          $ref: '#/components/schemas/PublicEmailTestingDetails'
        to:
          $ref: '#/components/schemas/PublicEmailToDetails'
        webversion:
          $ref: '#/components/schemas/PublicWebversionDetails'
    PublicEmail:
      required:
        - isAb
      type: object
      properties:
        activeDomain:
          type: string
          description: The active domain of the email.
        allEmailCampaignIds:
          type: array
          description: List of emailCampaignIds.
          items:
            type: string
        archived:
          type: boolean
          description: Determines if the email is archived or not.
        businessUnitId:
          type: string
        campaign:
          type: string
          description: The ID of the campaign this email is associated to.
        campaignName:
          type: string
          description: The name of the campaign.
        campaignUtm:
          type: string
        clonedFrom:
          type: string
          description: The ID of the email this email was cloned from.
        content:
          $ref: '#/components/schemas/PublicEmailContent'
        createdAt:
          type: string
          description: >-
            The date and time of the email's creation, in ISO8601
            representation.
          format: date-time
        createdById:
          type: string
          description: The id of the user who created the email.
        deletedAt:
          type: string
          description: >-
            The date and time the email was deleted at, in ISO8601
            representation.
          format: date-time
        emailCampaignGroupId:
          type: string
        emailTemplateMode:
          type: string
          enum:
            - DESIGN_MANAGER
            - DRAG_AND_DROP
        feedbackSurveyId:
          type: string
          description: The ID of the feedback survey linked to the email.
        folderId:
          type: integer
          format: int64
        folderIdV2:
          type: integer
          format: int64
        from:
          $ref: '#/components/schemas/PublicEmailFromDetails'
        id:
          type: string
          description: The email ID.
        isAb:
          type: boolean
        isPublished:
          type: boolean
          description: Returns the published status of the email. This is read only.
        isTransactional:
          type: boolean
          description: >-
            Returns whether the email is a transactional email or not. This is
            read only.
        jitterSendTime:
          type: boolean
        language:
          type: string
          enum:
            - 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:
          type: string
          description: The name of the email, as displayed on the email dashboard.
        previewKey:
          type: string
        primaryEmailCampaignId:
          type: string
        publishDate:
          type: string
          description: >-
            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:
          type: string
          description: >-
            The date and time the email was published at, in ISO8601
            representation.
          format: date-time
        publishedByEmail:
          type: string
          description: Email of the user who published/sent the email.
        publishedById:
          type: string
          description: The ID of the user who published the email.
        publishedByName:
          type: string
          description: Name of the user who published the email.
        rssData:
          $ref: '#/components/schemas/PublicRssEmailDetails'
        sendOnPublish:
          type: boolean
          description: Determines whether the email will be sent immediately on publish.
        state:
          type: string
          description: The email state.
          enum:
            - 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:
          $ref: '#/components/schemas/EmailStatisticsData'
        subcategory:
          type: string
          description: The email subcategory.
        subject:
          type: string
          description: The subject of the email.
        subscriptionDetails:
          $ref: '#/components/schemas/PublicEmailSubscriptionDetails'
        teamsWithAccess:
          type: array
          items:
            type: string
        testing:
          $ref: '#/components/schemas/PublicEmailTestingDetails'
        to:
          $ref: '#/components/schemas/PublicEmailToDetails'
        type:
          type: string
          description: >-
            The email type, this is derived from other properties on the email
            such as subcategory.
          enum:
            - 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:
          type: string
          format: date-time
        updatedAt:
          type: string
          description: >-
            The date and time of the last update to the email, in ISO8601
            representation.
          format: date-time
        updatedById:
          type: string
          description: The id of the user who last updated the email.
        usersWithAccess:
          type: array
          items:
            type: string
        webversion:
          $ref: '#/components/schemas/PublicWebversionDetails'
        workflowNames:
          type: array
          description: >-
            Names of workflows in which the email is used within a "send email"
            action.
          items:
            type: string
    PublicEmailContent:
      type: object
      properties:
        flexAreas:
          type: object
          additionalProperties:
            type: object
            properties: {}
        plainTextVersion:
          type: string
        smartFields:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SmartEmailField'
        styleSettings:
          $ref: '#/components/schemas/PublicEmailStyleSettings'
        templatePath:
          type: string
        themeSettingsValues:
          type: object
          additionalProperties:
            type: object
            properties: {}
        widgetContainers:
          type: object
          additionalProperties:
            type: object
            properties: {}
        widgets:
          type: object
          additionalProperties:
            type: object
            properties: {}
    PublicEmailFromDetails:
      type: object
      properties:
        customReplyTo:
          type: string
          description: The reply to recipients will see.
        fromName:
          type: string
          description: The name recipients will see.
        replyTo:
          type: string
          description: >-
            The from address and reply to email address (if no customReplyTo
            defined) recipients will see.
    PublicRssEmailDetails:
      type: object
      properties:
        blogEmailType:
          type: string
        blogImageMaxWidth:
          type: integer
          format: int32
        blogLayout:
          type: string
          enum:
            - FULL_POST
            - SUMMARY_NO_FEATURED_IMAGE
            - SUMMARY_WITH_FEATURED_IMAGE
        hubspotBlogId:
          type: string
        maxEntries:
          type: integer
          format: int32
        rssEntryTemplate:
          type: string
        timing:
          type: object
          additionalProperties:
            type: object
            properties: {}
        url:
          type: string
        useHeadlineAsSubject:
          type: boolean
    PublicEmailSubscriptionDetails:
      type: object
      properties:
        officeLocationId:
          type: string
          description: ID of the selected office location.
        preferencesGroupId:
          type: string
        subscriptionId:
          type: string
          description: ID of the subscription.
        subscriptionName:
          type: string
    PublicEmailTestingDetails:
      required:
        - isAbVariation
      type: object
      properties:
        abSampleSizeDefault:
          type: string
          description: >-
            Version of the email that should be sent if there are too few
            recipients to conduct an AB test.
          enum:
            - automated_loser_variant
            - automated_master
            - automated_variant
            - loser_variant
            - mab_master
            - mab_variant
            - master
            - variant
        abSamplingDefault:
          type: string
          description: >-
            Version of the email that should be sent if the results are
            inconclusive after the test period, master or variant.
          enum:
            - automated_loser_variant
            - automated_master
            - automated_variant
            - loser_variant
            - mab_master
            - mab_variant
            - master
            - variant
        abStatus:
          type: string
          description: Status of the AB test.
          enum:
            - automated_loser_variant
            - automated_master
            - automated_variant
            - loser_variant
            - mab_master
            - mab_variant
            - master
            - variant
        abSuccessMetric:
          type: string
          description: >-
            Metric to determine the version that will be sent to the remaining
            contacts.
          enum:
            - CLICKS_BY_DELIVERED
            - CLICKS_BY_OPENS
            - OPENS_BY_DELIVERED
        abTestPercentage:
          type: integer
          description: The size of your test group.
          format: int32
        hoursToWait:
          type: integer
          description: >-
            Time limit on gathering test results. After this time is up, the
            winning version will be sent to the remaining contacts.
          format: int32
        isAbVariation:
          type: boolean
        testId:
          type: string
          description: The ID of the AB test.
    PublicEmailToDetails:
      type: object
      properties:
        contactIds:
          $ref: '#/components/schemas/PublicEmailRecipients'
        contactIlsLists:
          $ref: '#/components/schemas/PublicEmailRecipients'
        contactLists:
          $ref: '#/components/schemas/PublicEmailRecipients'
        limitSendFrequency:
          type: boolean
        suppressGraymail:
          type: boolean
          description: Whether to send to unengaged contacts (false) or not (true).
    PublicWebversionDetails:
      type: object
      properties:
        domain:
          type: string
        enabled:
          type: boolean
        expiresAt:
          type: string
          format: date-time
        isPageRedirected:
          type: boolean
        metaDescription:
          type: string
        pageExpiryEnabled:
          type: boolean
        redirectToPageId:
          type: string
        redirectToUrl:
          type: string
        slug:
          type: string
        title:
          type: string
        url:
          type: string
    EmailStatisticsData:
      required:
        - counters
        - deviceBreakdown
        - qualifierStats
        - ratios
      type: object
      properties:
        counters:
          type: object
          additionalProperties:
            type: integer
            format: int64
          description: Counters like number of `sent`, `open` or `delivered`.
        deviceBreakdown:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: integer
              format: int64
          description: Statistics by device.
        qualifierStats:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: integer
              format: int64
          description: Number of emails that were dropped and bounced.
        ratios:
          type: object
          additionalProperties:
            type: number
          description: Ratios like `openratio` or `clickratio`
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: The error category
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            A unique identifier for the request. Include this value with any
            error reports or support tickets
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: further information about the error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            A map of link names to associated URIs containing documentation
            about the error or recommended remediation steps
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate
          example: An error occurred
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    SmartEmailField:
      type: object
      properties: {}
    PublicEmailStyleSettings:
      type: object
      properties:
        backgroundColor:
          type: string
        backgroundImage:
          type: string
        backgroundImageType:
          type: string
          enum:
            - REPEAT
            - SINGLE
            - STRETCH
        bodyBorderColor:
          type: string
        bodyBorderColorChoice:
          type: string
        bodyBorderWidth:
          type: number
        bodyColor:
          type: string
        buttonStyleSettings:
          $ref: '#/components/schemas/PublicButtonStyleSettings'
        colorPickerFavorite1:
          type: string
        colorPickerFavorite2:
          type: string
        colorPickerFavorite3:
          type: string
        colorPickerFavorite4:
          type: string
        colorPickerFavorite5:
          type: string
        colorPickerFavorite6:
          type: string
        dividerStyleSettings:
          $ref: '#/components/schemas/PublicDividerStyleSettings'
        emailBodyPadding:
          type: string
        emailBodyWidth:
          type: string
        headingOneFont:
          $ref: '#/components/schemas/PublicFontStyle'
        headingTwoFont:
          $ref: '#/components/schemas/PublicFontStyle'
        linksFont:
          $ref: '#/components/schemas/PublicFontStyle'
        primaryAccentColor:
          type: string
        primaryFont:
          type: string
        primaryFontColor:
          type: string
        primaryFontLineHeight:
          type: string
        primaryFontSize:
          type: number
        secondaryAccentColor:
          type: string
        secondaryFont:
          type: string
        secondaryFontColor:
          type: string
        secondaryFontLineHeight:
          type: string
        secondaryFontSize:
          type: number
    PublicEmailRecipients:
      type: object
      properties:
        exclude:
          type: array
          description: Excluded IDs.
          items:
            type: string
        include:
          type: array
          description: Included IDs.
          items:
            type: string
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: The status code associated with the error detail
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: The name of the field or parameter in which the error was found.
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error
    PublicButtonStyleSettings:
      type: object
      properties:
        backgroundColor:
          type: object
          properties: {}
        cornerRadius:
          type: integer
          format: int32
        fontStyle:
          $ref: '#/components/schemas/PublicFontStyle'
    PublicDividerStyleSettings:
      type: object
      properties:
        color:
          type: object
          properties: {}
        height:
          type: integer
          format: int32
        lineType:
          type: string
    PublicFontStyle:
      type: object
      properties:
        bold:
          type: boolean
        color:
          type: string
        font:
          type: string
        italic:
          type: boolean
        size:
          type: integer
          format: int32
        underline:
          type: boolean
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            content: ''
            transactional-email: ''

````