Skip to main content
PATCH
/
marketing
/
emails
/
2026-03
/
{emailId}
cURL
curl --request PATCH \
  --url https://api.hubapi.com/marketing/emails/2026-03/{emailId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "activeDomain": "<string>",
  "archived": true,
  "businessUnitId": 123,
  "campaign": "<string>",
  "content": {
    "flexAreas": {},
    "plainTextVersion": "<string>",
    "smartFields": {},
    "styleSettings": {
      "backgroundColor": "<string>",
      "backgroundImage": "<string>",
      "backgroundImageType": "REPEAT",
      "bodyBorderColor": "<string>",
      "bodyBorderColorChoice": "<string>",
      "bodyBorderWidth": 123,
      "bodyColor": "<string>",
      "buttonStyleSettings": {
        "backgroundColor": {},
        "cornerRadius": 123,
        "fontStyle": {
          "bold": true,
          "color": "<string>",
          "font": "<string>",
          "italic": true,
          "size": 123,
          "underline": true
        }
      },
      "colorPickerFavorite1": "<string>",
      "colorPickerFavorite2": "<string>",
      "colorPickerFavorite3": "<string>",
      "colorPickerFavorite4": "<string>",
      "colorPickerFavorite5": "<string>",
      "colorPickerFavorite6": "<string>",
      "dividerStyleSettings": {
        "color": {},
        "height": 123,
        "lineType": "<string>"
      },
      "emailBodyPadding": "<string>",
      "emailBodyWidth": "<string>",
      "headingOneFont": {
        "bold": true,
        "color": "<string>",
        "font": "<string>",
        "italic": true,
        "size": 123,
        "underline": true
      },
      "headingTwoFont": {
        "bold": true,
        "color": "<string>",
        "font": "<string>",
        "italic": true,
        "size": 123,
        "underline": true
      },
      "linksFont": {
        "bold": true,
        "color": "<string>",
        "font": "<string>",
        "italic": true,
        "size": 123,
        "underline": true
      },
      "primaryAccentColor": "<string>",
      "primaryFont": "<string>",
      "primaryFontColor": "<string>",
      "primaryFontLineHeight": "<string>",
      "primaryFontSize": 123,
      "secondaryAccentColor": "<string>",
      "secondaryFont": "<string>",
      "secondaryFontColor": "<string>",
      "secondaryFontLineHeight": "<string>",
      "secondaryFontSize": 123
    },
    "templatePath": "<string>",
    "themeSettingsValues": {},
    "widgetContainers": {},
    "widgets": {}
  },
  "folderIdV2": 123,
  "from": {
    "customReplyTo": "<string>",
    "fromName": "<string>",
    "replyTo": "<string>"
  },
  "jitterSendTime": true,
  "language": "aa",
  "name": "<string>",
  "publishDate": "2023-11-07T05:31:56Z",
  "rssData": {
    "blogEmailType": "<string>",
    "blogImageMaxWidth": 123,
    "blogLayout": "FULL_POST",
    "hubspotBlogId": "<string>",
    "maxEntries": 123,
    "rssEntryTemplate": "<string>",
    "timing": {},
    "url": "<string>",
    "useHeadlineAsSubject": true
  },
  "sendOnPublish": true,
  "state": "AGENT_GENERATED",
  "subcategory": "ab_loser_variant",
  "subject": "<string>",
  "subscriptionDetails": {
    "officeLocationId": "<string>",
    "preferencesGroupId": "<string>",
    "subscriptionId": "<string>",
    "subscriptionName": "<string>"
  },
  "testing": {
    "isAbVariation": true,
    "abSampleSizeDefault": "automated_loser_variant",
    "abSamplingDefault": "automated_loser_variant",
    "abStatus": "automated_loser_variant",
    "abSuccessMetric": "CLICKS_BY_DELIVERED",
    "abTestPercentage": 123,
    "hoursToWait": 123,
    "testId": "<string>"
  },
  "to": {
    "contactIds": {
      "exclude": [
        "<string>"
      ],
      "include": [
        "<string>"
      ]
    },
    "contactIlsLists": {
      "exclude": [
        "<string>"
      ],
      "include": [
        "<string>"
      ]
    },
    "contactLists": {
      "exclude": [
        "<string>"
      ],
      "include": [
        "<string>"
      ]
    },
    "limitSendFrequency": true,
    "suppressGraymail": true
  },
  "webversion": {
    "domain": "<string>",
    "enabled": true,
    "expiresAt": "2023-11-07T05:31:56Z",
    "isPageRedirected": true,
    "metaDescription": "<string>",
    "pageExpiryEnabled": true,
    "redirectToPageId": "<string>",
    "redirectToUrl": "<string>",
    "slug": "<string>",
    "title": "<string>",
    "url": "<string>"
  }
}
'
{
  "isAb": true,
  "activeDomain": "<string>",
  "allEmailCampaignIds": [
    "<string>"
  ],
  "archived": true,
  "businessUnitId": "<string>",
  "campaign": "<string>",
  "campaignName": "<string>",
  "campaignUtm": "<string>",
  "clonedFrom": "<string>",
  "content": {
    "flexAreas": {},
    "plainTextVersion": "<string>",
    "smartFields": {},
    "styleSettings": {
      "backgroundColor": "<string>",
      "backgroundImage": "<string>",
      "backgroundImageType": "REPEAT",
      "bodyBorderColor": "<string>",
      "bodyBorderColorChoice": "<string>",
      "bodyBorderWidth": 123,
      "bodyColor": "<string>",
      "buttonStyleSettings": {
        "backgroundColor": {},
        "cornerRadius": 123,
        "fontStyle": {
          "bold": true,
          "color": "<string>",
          "font": "<string>",
          "italic": true,
          "size": 123,
          "underline": true
        }
      },
      "colorPickerFavorite1": "<string>",
      "colorPickerFavorite2": "<string>",
      "colorPickerFavorite3": "<string>",
      "colorPickerFavorite4": "<string>",
      "colorPickerFavorite5": "<string>",
      "colorPickerFavorite6": "<string>",
      "dividerStyleSettings": {
        "color": {},
        "height": 123,
        "lineType": "<string>"
      },
      "emailBodyPadding": "<string>",
      "emailBodyWidth": "<string>",
      "headingOneFont": {
        "bold": true,
        "color": "<string>",
        "font": "<string>",
        "italic": true,
        "size": 123,
        "underline": true
      },
      "headingTwoFont": {
        "bold": true,
        "color": "<string>",
        "font": "<string>",
        "italic": true,
        "size": 123,
        "underline": true
      },
      "linksFont": {
        "bold": true,
        "color": "<string>",
        "font": "<string>",
        "italic": true,
        "size": 123,
        "underline": true
      },
      "primaryAccentColor": "<string>",
      "primaryFont": "<string>",
      "primaryFontColor": "<string>",
      "primaryFontLineHeight": "<string>",
      "primaryFontSize": 123,
      "secondaryAccentColor": "<string>",
      "secondaryFont": "<string>",
      "secondaryFontColor": "<string>",
      "secondaryFontLineHeight": "<string>",
      "secondaryFontSize": 123
    },
    "templatePath": "<string>",
    "themeSettingsValues": {},
    "widgetContainers": {},
    "widgets": {}
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "createdById": "<string>",
  "deletedAt": "2023-11-07T05:31:56Z",
  "emailCampaignGroupId": "<string>",
  "emailTemplateMode": "DESIGN_MANAGER",
  "feedbackSurveyId": "<string>",
  "folderId": 123,
  "folderIdV2": 123,
  "from": {
    "customReplyTo": "<string>",
    "fromName": "<string>",
    "replyTo": "<string>"
  },
  "id": "<string>",
  "isPublished": true,
  "isTransactional": true,
  "jitterSendTime": true,
  "language": "aa",
  "name": "<string>",
  "previewKey": "<string>",
  "primaryEmailCampaignId": "<string>",
  "publishDate": "2023-11-07T05:31:56Z",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedByEmail": "<string>",
  "publishedById": "<string>",
  "publishedByName": "<string>",
  "rssData": {
    "blogEmailType": "<string>",
    "blogImageMaxWidth": 123,
    "blogLayout": "FULL_POST",
    "hubspotBlogId": "<string>",
    "maxEntries": 123,
    "rssEntryTemplate": "<string>",
    "timing": {},
    "url": "<string>",
    "useHeadlineAsSubject": true
  },
  "sendOnPublish": true,
  "state": "AGENT_GENERATED",
  "stats": {
    "counters": {},
    "deviceBreakdown": {},
    "qualifierStats": {},
    "ratios": {}
  },
  "subcategory": "<string>",
  "subject": "<string>",
  "subscriptionDetails": {
    "officeLocationId": "<string>",
    "preferencesGroupId": "<string>",
    "subscriptionId": "<string>",
    "subscriptionName": "<string>"
  },
  "teamsWithAccess": [
    "<string>"
  ],
  "testing": {
    "isAbVariation": true,
    "abSampleSizeDefault": "automated_loser_variant",
    "abSamplingDefault": "automated_loser_variant",
    "abStatus": "automated_loser_variant",
    "abSuccessMetric": "CLICKS_BY_DELIVERED",
    "abTestPercentage": 123,
    "hoursToWait": 123,
    "testId": "<string>"
  },
  "to": {
    "contactIds": {
      "exclude": [
        "<string>"
      ],
      "include": [
        "<string>"
      ]
    },
    "contactIlsLists": {
      "exclude": [
        "<string>"
      ],
      "include": [
        "<string>"
      ]
    },
    "contactLists": {
      "exclude": [
        "<string>"
      ],
      "include": [
        "<string>"
      ]
    },
    "limitSendFrequency": true,
    "suppressGraymail": true
  },
  "type": "AB_EMAIL",
  "unpublishedAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedById": "<string>",
  "usersWithAccess": [
    "<string>"
  ],
  "webversion": {
    "domain": "<string>",
    "enabled": true,
    "expiresAt": "2023-11-07T05:31:56Z",
    "isPageRedirected": true,
    "metaDescription": "<string>",
    "pageExpiryEnabled": true,
    "redirectToPageId": "<string>",
    "redirectToUrl": "<string>",
    "slug": "<string>",
    "title": "<string>",
    "url": "<string>"
  },
  "workflowNames": [
    "<string>"
  ]
}

Supported products

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
emailId
string
required

Query Parameters

​
archived
boolean

Whether to return only results that have been archived.

Body

application/json
​
activeDomain
string

The active domain of the email.

​
archived
boolean

Determines if the email is archived or not.

​
businessUnitId
integer<int64>

The ID of the business unit associated with the email.

​
campaign
string

The ID of the campaign this email is associated to.

​
content
object
​
folderIdV2
integer<int64>

The ID of the folder where the email will be stored.

​
from
object
​
jitterSendTime
boolean

Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.

​
language
enum<string>

The language code for the email, such as 'en' for English.

Available options:
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
​
name
string

The name of the email, as displayed on the email dashboard.

​
publishDate
string<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
object
​
sendOnPublish
boolean

Determines whether the email will be sent immediately on publish.

​
state
enum<string>

The email state.

Available options:
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
enum<string>

The email subcategory.

Available options:
ab_loser_variant,
ab_loser_variant_site_page,
ab_master,
ab_master_site_page,
ab_variant,
ab_variant_site_page,
automated,
automated_ab_master,
automated_ab_variant,
automated_for_crm,
automated_for_custom_survey,
automated_for_deal,
automated_for_feedback_ces,
automated_for_feedback_custom,
automated_for_feedback_nps,
automated_for_form,
automated_for_form_buffer,
automated_for_form_draft,
automated_for_form_legacy,
automated_for_leadflow,
automated_for_ticket,
batch,
blog_article_instance_layout,
blog_article_listing,
blog_author_detail,
blog_email,
blog_email_child,
case_study,
case_study_instance_layout,
case_study_listing,
discardable_stub,
imported_blog_post,
kb_404_page,
kb_article_instance_layout,
kb_listing,
kb_search_results,
kb_support_form,
landing_page,
legacy_blog_post,
legacy_page,
localtime,
manage_preferences_email,
marketing_single_send_api,
membership_email_verification,
membership_follow_up,
membership_otp_login,
membership_password_reset,
membership_password_saved,
membership_passwordless_auth,
membership_registration,
membership_registration_follow_up,
membership_verification,
normal_blog_post,
optin_email,
optin_followup_email,
page_instance_layout,
page_stub,
performable_landing_page,
performable_landing_page_cutover,
podcast_instance_layout,
podcast_listing,
portal_content,
resubscribe_confirmation_email,
resubscribe_email,
rss_to_email,
rss_to_email_child,
scp_instance_layout_page,
scp_static_page,
single_send_api,
site_page,
smtp_token,
staged_page,
ticket_closed_kickback_email,
ticket_opened_kickback_email,
ticket_pipeline_automated,
UNKNOWN,
unsubscribe_confirmation_email,
web_interactive
​
subject
string

The subject of the email.

​
subscriptionDetails
object
​
testing
object
​
to
object
​
webversion
object

Response

successful operation

​
isAb
boolean
required
​
activeDomain
string

The active domain of the email.

​
allEmailCampaignIds
string[]

List of emailCampaignIds.

​
archived
boolean

Determines if the email is archived or not.

​
businessUnitId
string
​
campaign
string

The campaign GUID on the email.

​
campaignName
string

The name of the campaign.

​
campaignUtm
string
​
clonedFrom
string

The ID of the email this email was cloned from.

​
content
object
​
createdAt
string<date-time>

The date and time of the email's creation, in ISO8601 representation.

​
createdById
string

The id of the user who created the email.

​
deletedAt
string<date-time>

The date and time the email was deleted at, in ISO8601 representation.

​
emailCampaignGroupId
string
​
emailTemplateMode
enum<string>
Available options:
DESIGN_MANAGER,
DRAG_AND_DROP
​
feedbackSurveyId
string

The ID of the feedback survey linked to the email.

​
folderId
integer<int64>
​
folderIdV2
integer<int64>
​
from
object
​
id
string

The email ID.

​
isPublished
boolean

Returns the published status of the email. This is read only.

​
isTransactional
boolean

Returns whether the email is a transactional email or not. This is read only.

​
jitterSendTime
boolean
​
language
enum<string>
Available options:
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
​
name
string

The name of the email, as displayed on the email dashboard.

​
previewKey
string
​
primaryEmailCampaignId
string
​
publishDate
string<date-time>

The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.

​
publishedAt
string<date-time>

The date and time the email was published at, in ISO8601 representation.

​
publishedByEmail
string

Email of the user who published/sent the email.

​
publishedById
string

The ID of the user who published the email.

​
publishedByName
string

Name of the user who published the email.

​
rssData
object
​
sendOnPublish
boolean

Determines whether the email will be sent immediately on publish.

​
state
enum<string>

The email state.

Available options:
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
object
​
subcategory
string

The email subcategory.

​
subject
string

The subject of the email.

​
subscriptionDetails
object
​
teamsWithAccess
string[]
​
testing
object
​
to
object
​
type
enum<string>

The email type, this is derived from other properties on the email such as subcategory.

Available options:
AB_EMAIL,
AUTOMATED_AB_EMAIL,
AUTOMATED_EMAIL,
BATCH_EMAIL,
BLOG_EMAIL,
BLOG_EMAIL_CHILD,
FEEDBACK_CES_EMAIL,
FEEDBACK_CUSTOM_EMAIL,
FEEDBACK_CUSTOM_SURVEY_EMAIL,
FEEDBACK_NPS_EMAIL,
FOLLOWUP_EMAIL,
LEADFLOW_EMAIL,
LOCALTIME_EMAIL,
MANAGE_PREFERENCES_EMAIL,
MARKETING_SINGLE_SEND_API,
MEMBERSHIP_EMAIL_VERIFICATION_EMAIL,
MEMBERSHIP_FOLLOW_UP_EMAIL,
MEMBERSHIP_OTP_LOGIN_EMAIL,
MEMBERSHIP_PASSWORD_RESET_EMAIL,
MEMBERSHIP_PASSWORD_SAVED_EMAIL,
MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL,
MEMBERSHIP_REGISTRATION_EMAIL,
MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL,
MEMBERSHIP_VERIFICATION_EMAIL,
OPTIN_EMAIL,
OPTIN_FOLLOWUP_EMAIL,
RESUBSCRIBE_EMAIL,
RSS_EMAIL,
RSS_EMAIL_CHILD,
SINGLE_SEND_API,
SMTP_TOKEN,
TICKET_EMAIL
​
unpublishedAt
string<date-time>
​
updatedAt
string<date-time>

The date and time of the last update to the email, in ISO8601 representation.

​
updatedById
string

The ID of the user who last updated the email.

​
usersWithAccess
string[]
​
webversion
object
​
workflowNames
string[]

Names of workflows in which the email is used within a "send email" action.

Last modified on March 30, 2026