HubSpot: Pages schemas
46 HubSpot schemas with complete fields and constraints.
← Pages operations · All schemas
Clone a landing page — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
abStatus | string | Required within parent | The status of the AB test associated with this page, if applicable Known values: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant |
abTestId | string | Required within parent | The ID of the AB test associated with this page, if applicable |
archivedAt | string | Required within parent | The timestamp when this page was deleted. Format: date-time |
archivedInDashboard | boolean | Required within parent | If True, the page will not show up in your dashboard, although the page could still be live. |
attachedStylesheets | array | Required within parent | List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML. |
attachedStylesheets[] | object | Each item | Additional keys: see wildcard field |
attachedStylesheets[].* | object | Additional keys | |
authorName | string | Required within parent | The name of the user that updated this page. |
campaign | string | Required within parent | The GUID of the marketing campaign this page is a part of. |
categoryId | JSON | Required within parent | |
categoryId (anyOf 1) | integer | Alternative | ID of the type of object this is. Should always . Format: int32 |
categoryId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
contentGroupId | string | Required within parent | Required when creating or cloning blog posts. The unique identifier for the content group associated with the blog. |
contentTypeCategory | string | Required within parent | An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE. Known values: 0, 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 3, 4, 5, 6, 7, 8, 9 |
created | string | Required within parent | The timestamp indicating when the page was created. Format: date-time |
createdById | string | Required within parent | The ID of the user that created this page. |
currentState | string | Required within parent | A generated ENUM descibing the current state of this page. Known values: AGENT_GENERATED, AUTOMATED, AUTOMATED_AB, AUTOMATED_AB_VARIANT, AUTOMATED_DRAFT, AUTOMATED_DRAFT_AB, AUTOMATED_DRAFT_ABVARIANT, AUTOMATED_FOR_FORM, AUTOMATED_FOR_FORM_BUFFER, AUTOMATED_FOR_FORM_DRAFT, AUTOMATED_FOR_FORM_LEGACY, AUTOMATED_LOSER_ABVARIANT, AUTOMATED_SENDING, BLOG_EMAIL_DRAFT, BLOG_EMAIL_PUBLISHED, DRAFT, DRAFT_AB, DRAFT_AB_VARIANT, ERROR, LOSER_AB_VARIANT, PAGE_STUB, PRE_PROCESSING, PROCESSING, PUBLISHED, PUBLISHED_AB, PUBLISHED_AB_VARIANT, PUBLISHED_OR_SCHEDULED, RSS_TO_EMAIL_DRAFT, RSS_TO_EMAIL_PUBLISHED, SCHEDULED, SCHEDULED_AB, SCHEDULED_OR_PUBLISHED |
currentlyPublished | boolean | Required within parent | Indicates whether the page is currently published. |
domain | string | Required within parent | The domain this page will resolve to. If null, the page will default to the primary domain for this content type. |
dynamicPageDataSourceId | string | Required within parent | The identifier for the data source used by the dynamic page. |
dynamicPageDataSourceType | JSON | Required within parent | |
dynamicPageDataSourceType (anyOf 1) | integer | Alternative | The type of data source used by the dynamic page. Format: int32 |
dynamicPageDataSourceType (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
dynamicPageHubDbTableId | string | Required within parent | The ID of the HubDB table this page references, if applicable |
enableDomainStylesheets | boolean | Required within parent | Boolean to determine whether or not the styles from the template should be applied. |
enableLayoutStylesheets | boolean | Required within parent | Boolean to determine whether or not the styles from the template should be applied. |
featuredImage | string | Required within parent | The featuredImage of this page. |
featuredImageAltText | string | Required within parent | Alt Text of the featuredImage. |
folderId | string | Required within parent | The ID of the associated folder this landing page is organized under in the app dashboard. |
footerHtml | string | Required within parent | Custom HTML for embed codes, javascript that should be placed before the </body> tag of the page. |
headHtml | string | Required within parent | Custom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page. |
htmlTitle | string | Required within parent | The html title of this page. |
id | string | Required within parent | The unique ID of the page. |
includeDefaultCustomCss | boolean | Required within parent | Boolean to determine whether or not the Primary CSS Files should be applied. |
language | string | Required within parent | The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain. Known values: aa, ab, ae, af, af-na, af-za, agq, agq-cm, ak, ak-gh, am, am-et, an, ann, ann-ng, ar, ar-001, ar-ae, ar-bh, ar-dj, ar-dz, ar-eg, ar-eh, ar-er, ar-il, ar-iq, ar-jo, ar-km, ar-kw, ar-lb, ar-ly, ar-ma, ar-mr, ar-om, ar-ps, ar-qa, ar-sa, ar-sd, ar-so, ar-ss, ar-sy, ar-td, ar-tn, ar-ye, as, as-in, asa, asa-tz, ast, ast-es, av, ay, az, az-az, ba, bal, bal-pk, bas, bas-cm, be, be-by, bem, bem-zm, bez, bez-tz, bg, bg-bg, bgc, bgc-in, bho, bho-in, bi, blo, blo-bj, bm, bm-ml, bn, bn-bd, bn-in, bo, bo-cn, bo-in, br, br-fr, brx, brx-in, bs, bs-ba, ca, ca-ad, ca-es, ca-fr, ca-it, ccp, ccp-bd, ccp-in, ce, ce-ru, ceb, ceb-ph, cgg, cgg-ug, ch, chr, chr-us, ckb, ckb-iq, ckb-ir, co, cr, cs, cs-cz, csw, csw-ca, cu, cu-ru, cv, cv-ru, cy, cy-gb, da, da-dk, da-gl, dav, dav-ke, de, de-at, de-be, de-ch, de-de, de-gr, de-it, de-li, de-lu, dje, dje-ne, doi, doi-in, dsb, dsb-de, dua, dua-cm, dv, dyo, dyo-sn, dz, dz-bt, ebu, ebu-ke, ee, ee-gh, ee-tg, el, el-cy, el-gr, en, en-001, en-150, en-ae, en-ag, en-ai, en-as, en-at, en-au, en-bb, en-be, en-bi, en-bm, en-bs, en-bw, en-bz, en-ca, en-cc, en-ch, en-ck, en-cm, en-cn, en-cx, en-cy, en-cz, en-de, en-dg, en-dk, en-dm, en-ee, en-eg, en-er, en-es, en-fi, en-fj, en-fk, en-fm, en-fr, en-gb, en-gd, en-gg, en-gh, en-gi, en-gm, en-gs, en-gu, en-gy, en-hk, en-hu, en-id, en-ie, en-il, en-im, en-in, en-io, en-it, en-je, en-jm, en-ke, en-ki, en-kn, en-ky, en-lc, en-lr, en-ls, en-lu, en-mg, en-mh, en-mo, en-mp, en-ms, en-mt, en-mu, en-mv, en-mw, en-mx, en-my, en-na, en-nf, en-ng, en-nl, en-no, en-nr, en-nu, en-nz, en-pg, en-ph, en-pk, en-pl, en-pn, en-pr, en-pt, en-pw, en-ro, en-rw, en-sb, en-sc, en-sd, en-se, en-sg, en-sh, en-si, en-sk, en-sl, en-ss, en-sx, en-sz, en-tc, en-th, en-tk, en-tn, en-to, en-tt, en-tv, en-tz, en-ug, en-um, en-us, en-vc, en-vg, en-vi, en-vn, en-vu, en-ws, en-za, en-zm, en-zw, eo, eo-001, es, es-419, es-ar, es-bo, es-br, es-bz, es-cl, es-co, es-cr, es-cu, es-do, es-ea, es-ec, es-es, es-gq, es-gt, es-hn, es-ic, es-mx, es-ni, es-pa, es-pe, es-ph, es-pr, es-py, es-sv, es-us, es-uy, es-ve, et, et-ee, eu, eu-es, ewo, ewo-cm, fa, fa-af, fa-ir, ff, ff-bf, ff-cm, ff-gh, ff-gm, ff-gn, ff-gw, ff-lr, ff-mr, ff-ne, ff-ng, ff-sl, ff-sn, fi, fi-fi, fil, fil-ph, fj, fo, fo-dk, fo-fo, fr, fr-be, fr-bf, fr-bi, fr-bj, fr-bl, fr-ca, fr-cd, fr-cf, fr-cg, fr-ch, fr-ci, fr-cm, fr-dj, fr-dz, fr-fr, fr-ga, fr-gf, fr-gn, fr-gp, fr-gq, fr-ht, fr-km, fr-lu, fr-ma, fr-mc, fr-mf, fr-mg, fr-ml, fr-mq, fr-mr, fr-mu, fr-nc, fr-ne, fr-pf, fr-pm, fr-re, fr-rw, fr-sc, fr-sn, fr-sy, fr-td, fr-tg, fr-tn, fr-vu, fr-wf, fr-yt, frr, frr-de, fur, fur-it, fy, fy-nl, ga, ga-gb, ga-ie, gaa, gaa-gh, gd, gd-gb, gl, gl-es, gn, gsw, gsw-ch, gsw-fr, gsw-li, gu, gu-in, guz, guz-ke, gv, gv-im, ha, ha-gh, ha-ne, ha-ng, haw, haw-us, he, he-il, hi, hi-in, hmn, ho, hr, hr-ba, hr-hr, hsb, hsb-de, ht, ht-ht, hu, hu-hu, hy, hy-am, hz, ia, ia-001, id, id-id, ie, ie-ee, ig, ig-ng, ii, ii-cn, ik, io, is, is-is, it, it-ch, it-it, it-sm, it-va, iu, ja, ja-jp, jgo, jgo-cm, jmc, jmc-tz, jv, jv-id, ka, ka-ge, kab, kab-dz, kam, kam-ke, kar, kde, kde-tz, kea, kea-cv, kg, kgp, kgp-br, kh, khq, khq-ml, ki, ki-ke, kj, kk, kk-kz, kkj, kkj-cm, kl, kl-gl, kln, kln-ke, km, km-kh, kn, kn-in, ko, ko-cn, ko-kp, ko-kr, kok, kok-in, kr, ks, ks-in, ksb, ksb-tz, ksf, ksf-cm, ksh, ksh-de, ku, ku-tr, kv, kw, kw-gb, kxv, kxv-in, ky, ky-kg, la, lag, lag-tz, lb, lb-lu, lg, lg-ug, li, lij, lij-it, lkt, lkt-us, lmo, lmo-it, ln, ln-ao, ln-cd, ln-cf, ln-cg, lo, lo-la, lrc, lrc-iq, lrc-ir, lt, lt-lt, lu, lu-cd, luo, luo-ke, luy, luy-ke, lv, lv-lv, mai, mai-in, mas, mas-ke, mas-tz, mdf, mdf-ru, mer, mer-ke, mfe, mfe-mu, mg, mg-mg, mgh, mgh-mz, mgo, mgo-cm, mh, mi, mi-nz, mk, mk-mk, ml, ml-in, mn, mn-mn, mni, mni-in, mr, mr-in, ms, ms-bn, ms-id, ms-my, ms-sg, mt, mt-mt, mua, mua-cm, my, my-mm, mzn, mzn-ir, na, naq, naq-na, nb, nb-no, nb-sj, nd, nd-zw, nds, nds-de, nds-nl, ne, ne-in, ne-np, ng, nl, nl-aw, nl-be, nl-bq, nl-ch, nl-cw, nl-lu, nl-nl, nl-sr, nl-sx, nmg, nmg-cm, nn, nn-no, nnh, nnh-cm, no, no-no, nqo, nqo-gn, nr, nso, nso-za, nus, nus-ss, nv, ny, nyn, nyn-ug, oc, oc-es, oc-fr, oj, om, om-et, om-ke, or, or-in, os, os-ge, os-ru, pa, pa-in, pa-pk, pcm, pcm-ng, pi, pis, pis-sb, pl, pl-pl, prg, prg-001, ps, ps-af, ps-pk, pt, pt-ao, pt-br, pt-ch, pt-cv, pt-gq, pt-gw, pt-lu, pt-mo, pt-mz, pt-pt, pt-st, pt-tl, qu, qu-bo, qu-ec, qu-pe, raj, raj-in, rm, rm-ch, rn, rn-bi, ro, ro-md, ro-ro, rof, rof-tz, ru, ru-by, ru-kg, ru-kz, ru-md, ru-ru, ru-ua, rw, rw-rw, rwk, rwk-tz, sa, sa-in, sah, sah-ru, saq, saq-ke, sat, sat-in, sbp, sbp-tz, sc, sc-it, sd, sd-in, sd-pk, se, se-fi, se-no, se-se, seh, seh-mz, ses, ses-ml, sg, sg-cf, shi, shi-ma, si, si-lk, sk, sk-sk, sl, sl-si, sm, smn, smn-fi, sms, sms-fi, sn, sn-zw, so, so-dj, so-et, so-ke, so-so, sq, sq-al, sq-mk, sq-xk, sr, sr-ba, sr-cs, sr-me, sr-rs, sr-xk, ss, st, st-ls, st-za, su, su-id, sv, sv-ax, sv-fi, sv-se, sw, sw-cd, sw-ke, sw-tz, sw-ug, sy, syr, syr-iq, syr-sy, szl, szl-pl, ta, ta-in, ta-lk, ta-my, ta-sg, te, te-in, teo, teo-ke, teo-ug, tg, tg-tj, th, th-th, ti, ti-er, ti-et, tk, tk-tm, tl, tn, tn-bw, tn-za, to, to-to, tok, tok-001, tr, tr-cy, tr-tr, ts, tt, tt-ru, tw, twq, twq-ne, ty, tzm, tzm-ma, ug, ug-cn, uk, uk-ua, ur, ur-in, ur-pk, uz, uz-af, uz-uz, vai, vai-lr, ve, vec, vec-it, vi, vi-vn, vmw, vmw-mz, vo, vo-001, vun, vun-tz, wa, wae, wae-ch, wo, wo-sn, xh, xh-za, xnr, xnr-in, xog, xog-ug, yav, yav-cm, yi, yi-001, yi-ua, yo, yo-bj, yo-ng, yrl, yrl-br, yrl-co, yrl-ve, yue, yue-cn, yue-hk, yue-mo, za, za-cn, zgh, zgh-ma, zh, zh-cn, zh-hans, zh-hant, zh-hk, zh-mo, zh-my, zh-sg, zh-tw, zu, zu-za |
layoutSections | object | Required within parent | A structure detailing the layout sections of the page. Additional keys: see wildcard field |
layoutSections.* | Model | Additional keys | Expand Clone a landing page — response body — layout Sections value |
linkRelCanonicalUrl | string | Required within parent | Optional override to set the URL to be used in the rel=canonical link tag on the page. |
mabExperimentId | string | Required within parent | The ID of the MAB test (or dynamic test) associated with this page, if applicable |
metaDescription | string | Required within parent | A description that goes in <meta> tag on the page. |
name | string | Required within parent | The internal name of the page. |
pageExpiryDate | JSON | Required within parent | |
pageExpiryDate (anyOf 1) | integer | Alternative | The date at which this page should expire and begin redirecting to another url or page. Format: int64 |
pageExpiryDate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pageExpiryEnabled | boolean | Required within parent | Boolean describing if the page expiration feature is enabled for this page |
pageExpiryRedirectId | JSON | Required within parent | |
pageExpiryRedirectId (anyOf 1) | integer | Alternative | The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl. Format: int64 |
pageExpiryRedirectId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pageExpiryRedirectUrl | string | Required within parent | The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId. |
pageRedirected | boolean | Required within parent | A generated Boolean describing whether or not this page is currently expired and being redirected. |
password | string | Required within parent | Set this to create a password protected page. Entering the password will be required to view the page. |
publicAccessRules | array | Required within parent | Rules for require member registration to access private content. |
publicAccessRules[] | Model | Each item | Expand List tags — response body |
publicAccessRulesEnabled | boolean | Required within parent | Boolean to determine whether or not to respect publicAccessRules. |
publishDate | string | Required within parent | The date (ISO8601 format) the page is to be published at. Format: date-time |
publishImmediately | boolean | Required within parent | Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting. |
slug | string | Required within parent | The path of the this page. This field is appended to the domain to construct the url of this page. |
state | string | Required within parent | An ENUM descibing the current state of this page. Maximum length: 25 |
subcategory | string | Required within parent | Details the type of page this is. Should always be landing_page or site_page |
templatePath | string | Required within parent | String detailing the path of the template used for this page. |
themeSettingsValues | object | Required within parent | A collection of settings specific to the theme applied to the page. Additional keys: see wildcard field |
themeSettingsValues.* | object | Additional keys | |
translatedFromId | string | Required within parent | ID of the primary page this object was translated from. |
translations | object | Required within parent | A map of translations for the page, each associated with a specific language variation. Additional keys: see wildcard field |
translations.* | Model | Additional keys | Expand Clone a landing page — response body — translations value |
updated | string | Required within parent | The timestamp indicating when the page was last updated. Format: date-time |
updatedById | string | Required within parent | The ID of the user that updated this page. |
url | string | Required within parent | A generated field representing the URL of this page. |
useFeaturedImage | boolean | Required within parent | Boolean to determine if this page should use a featuredImage. |
widgetContainers | object | Required within parent | A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers. Additional keys: see wildcard field |
widgetContainers.* | object | Additional keys | |
widgets | object | Required within parent | A data structure containing the data for all the modules for this page. Additional keys: see wildcard field |
widgets.* | object | Additional keys |
Referenced models: List tags — response body, Clone a landing page — response body — translations value, Clone a landing page — response body — layout Sections value
Clone a landing page — response body — layout Sections value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells | array | Required within parent | The individual cells within the section, each representing a distinct area for content placement. |
cells[] | Model | Each item | Expand Clone a landing page — response body — layout Sections value |
cssClass | string | Required within parent | The CSS class applied to the layout section. |
cssId | string | Required within parent | The CSS ID applied to the layout section. |
cssStyle | string | Required within parent | Custom CSS styles applied to the layout section. |
label | string | Required within parent | The label for the layout section. |
name | string | Required within parent | The internal name of the page. |
params | object | Required within parent | Parameters associated with the layout section. Additional keys: see wildcard field |
params.* | object | Additional keys | |
rowMetaData | array | Required within parent | Metadata about the rows within the section, such as styling or configuration details. |
rowMetaData[] | Model | Each item | Expand Clone a landing page — response body — layout Sections value row Meta Data item |
rows | array | Required within parent | The number of rows contained within the section, used to organize content vertically. |
rows[] | object | Each item | Additional keys: see wildcard field |
rows[].* | Model | Additional keys | Expand Clone a landing page — response body — layout Sections value |
styles | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles |
type | string | Required within parent | The type of the layout section. |
w | JSON | Required within parent | |
w (anyOf 1) | integer | Alternative | The width of the layout section. Format: int32 |
w (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
x | JSON | Required within parent | |
x (anyOf 1) | integer | Alternative | The x-coordinate position of the layout section. Format: int32 |
x (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Clone a landing page — response body — layout Sections value, Clone a landing page — response body — layout Sections value row Meta Data item, Clone a landing page — response body — layout Sections value styles
Clone a landing page — response body — layout Sections value row Meta Data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cssClass | string | Required within parent | The CSS class applied to the row metadata. |
styles | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles |
Referenced models: Clone a landing page — response body — layout Sections value styles
Clone a landing page — response body — layout Sections value styles
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
backgroundColor | Model | Required within parent | Expand Update a post — response body — layout Sections value styles background Color |
backgroundGradient | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles background Gradient |
backgroundImage | Model | Required within parent | Expand Update a post — response body — layout Sections value styles background Image |
breakpointStyles | object | Optional | Contains style settings specific to different breakpoints. This property allows for responsive design adjustments based on screen size. Additional keys: see wildcard field |
breakpointStyles.* | Model | Additional keys | Expand Clone a landing page — response body — layout Sections value styles breakpoint Styles value |
flexboxPositioning | string | Required within parent | Indicates whether flexbox positioning is enabled for the section. Known values: BOTTOM_CENTER, BOTTOM_LEFT, BOTTOM_RIGHT, MIDDLE_CENTER, MIDDLE_LEFT, MIDDLE_RIGHT, TOP_CENTER, TOP_LEFT, TOP_RIGHT |
forceFullWidthSection | boolean | Required within parent | Determines if the section should be forced to full width. |
maxWidthSectionCentering | JSON | Required within parent | |
maxWidthSectionCentering (anyOf 1) | integer | Alternative | Defines the maximum width for centering the section. Format: int32 |
maxWidthSectionCentering (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
verticalAlignment | string | Required within parent | Specifies the vertical alignment of elements within the section. Known values: BOTTOM, MIDDLE, TOP |
Referenced models: Update a post — response body — layout Sections value styles background Image, Clone a landing page — response body — layout Sections value styles breakpoint Styles value, Clone a landing page — response body — layout Sections value styles background Gradient, Update a post — response body — layout Sections value styles background Color
Clone a landing page — response body — layout Sections value styles background Gradient
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
angle | Model | Required within parent | Expand Update a post — response body — layout Sections value styles background Gradient angle |
colors | array | Required within parent | An array of color values that make up the gradient. Each color is applied in sequence to create the gradient effect. |
colors[] | Model | Each item | Expand Update a post — response body — layout Sections value styles background Gradient colors item |
sideOrCorner | Model | Required within parent | Expand Update a post — response body — layout Sections value styles background Gradient side Or Corner |
Referenced models: Update a post — response body — layout Sections value styles background Gradient angle, Update a post — response body — layout Sections value styles background Gradient colors item, Update a post — response body — layout Sections value styles background Gradient side Or Corner
Clone a landing page — response body — layout Sections value styles breakpoint Styles value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hidden | boolean | Required within parent | A boolean indicating whether the element should be hidden at this breakpoint. A value of true means the element is not visible. |
margin | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin |
padding | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles breakpoint Styles value padding |
Referenced models: Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin, Clone a landing page — response body — layout Sections value styles breakpoint Styles value padding
Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bottom | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top |
top | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top |
Referenced models: Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top
Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
units | string | Required within parent | A string indicating the unit of measurement for the size value, such as 'pixels', 'inches', or 'centimeters'. Known values: CH, CM, EM, EX, IN, LH, MM, PC, PERCENTAGE, PT, PX, Q, REM, VH, VMAX, VMIN, VW |
value | JSON | Required within parent | |
value (anyOf 1) | number | Alternative | A numerical value representing the size dimension of the object. The data type is a number. |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Clone a landing page — response body — layout Sections value styles breakpoint Styles value padding
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bottom | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top |
left | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top |
right | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top |
top | Model | Required within parent | Expand Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top |
Referenced models: Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top
Clone a landing page — response body — translations value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archivedInDashboard | boolean | Required within parent | Indicates if the page is hidden from the dashboard, though it may still be live. |
authorName | string | Required within parent | The name of the user that updated this page. |
campaign | string | Required within parent | The GUID of the marketing campaign this page is a part of. |
campaignName | string | Required within parent | The name of the campaign associated with this language variation. |
created | string | Required within parent | The date and time when the content language variation was created. Format: date-time |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | ID of object to set as primary in multi-language group. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | The internal name of the page. |
password | string | Required within parent | A password required to view the page, if set. |
publicAccessRules | array | Required within parent | A list of rules defining public access permissions for this language variation. |
publicAccessRules[] | Model | Each item | Expand List tags — response body |
publicAccessRulesEnabled | boolean | Required within parent | Determines if public access rules should be respected. |
publishDate | string | Required within parent | The date and time when the page is scheduled to be published. Format: date-time |
slug | string | Required within parent | The path of this page, appended to the domain to construct the URL. |
state | string | Required within parent | An ENUM descibing the current state of this page. |
tagIds | array | Optional | A list of tag IDs associated with this language variation. |
tagIds[] | JSON | Each item | |
tagIds[] (anyOf 1) | integer | Alternative | Format: int64 |
tagIds[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated | string | Required within parent | The date and time when the content language variation was last updated. Format: date-time |
Referenced models: List tags — response body
Create a landing page folder — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | integer | Required within parent | The type of object this folder applies to. Should always be LANDING_PAGE. Format: int32 |
created | string | Required within parent | The timestamp indicating when the content folder was created. Format: date-time |
deletedAt | string | Required within parent | The timestamp (ISO8601 format) when this content folder was deleted. Format: date-time |
id | string | Required within parent | The unique ID of the content folder. |
name | string | Required within parent | The name of the folder which will show up in the app dashboard |
parentFolderId | integer | Required within parent | The ID of the content folder this folder is nested under Format: int64 |
updated | string | Required within parent | The timestamp indicating when the content folder was last updated. Format: date-time |
Create a landing page folder — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | JSON | Required within parent | |
category (anyOf 1) | integer | Alternative | The type of object this folder applies to. Should always be LANDING_PAGE. Format: int32 |
category (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created | string | Required within parent | The timestamp indicating when the content folder was created. Format: date-time |
deletedAt | string | Required within parent | The timestamp (ISO8601 format) when this content folder was deleted. Format: date-time |
id | string | Required within parent | The unique ID of the content folder. |
name | string | Required within parent | The name of the folder which will show up in the app dashboard |
parentFolderId | JSON | Required within parent | |
parentFolderId (anyOf 1) | integer | Alternative | The ID of the content folder this folder is nested under Format: int64 |
parentFolderId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated | string | Required within parent | The timestamp indicating when the content folder was last updated. Format: date-time |
Create a landing page — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
abStatus | string | Required within parent | The status of the AB test associated with this page, if applicable One of: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant |
abTestId | string | Required within parent | The ID of the AB test associated with this page, if applicable |
archivedAt | string | Required within parent | The timestamp when this page was deleted. Format: date-time |
archivedInDashboard | boolean | Required within parent | If True, the page will not show up in your dashboard, although the page could still be live. |
attachedStylesheets | array | Required within parent | List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML. |
attachedStylesheets[] | object | Each item | Additional keys: see wildcard field |
attachedStylesheets[].* | object | Additional keys | |
authorName | string | Required within parent | The name of the user that updated this page. |
campaign | string | Required within parent | The GUID of the marketing campaign this page is a part of. |
categoryId | integer | Required within parent | ID of the type of object this is. Should always . Format: int32 |
contentGroupId | string | Required within parent | Required when creating or cloning blog posts. The unique identifier for the content group associated with the blog. |
contentTypeCategory | string | Required within parent | An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE. One of: 0, 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 3, 4, 5, 6, 7, 8, 9 |
created | string | Required within parent | The timestamp indicating when the page was created. Format: date-time |
createdById | string | Required within parent | The ID of the user that created this page. |
currentState | string | Required within parent | A generated ENUM descibing the current state of this page. One of: AGENT_GENERATED, AUTOMATED, AUTOMATED_AB, AUTOMATED_AB_VARIANT, AUTOMATED_DRAFT, AUTOMATED_DRAFT_AB, AUTOMATED_DRAFT_ABVARIANT, AUTOMATED_FOR_FORM, AUTOMATED_FOR_FORM_BUFFER, AUTOMATED_FOR_FORM_DRAFT, AUTOMATED_FOR_FORM_LEGACY, AUTOMATED_LOSER_ABVARIANT, AUTOMATED_SENDING, BLOG_EMAIL_DRAFT, BLOG_EMAIL_PUBLISHED, DRAFT, DRAFT_AB, DRAFT_AB_VARIANT, ERROR, LOSER_AB_VARIANT, PAGE_STUB, PRE_PROCESSING, PROCESSING, PUBLISHED, PUBLISHED_AB, PUBLISHED_AB_VARIANT, PUBLISHED_OR_SCHEDULED, RSS_TO_EMAIL_DRAFT, RSS_TO_EMAIL_PUBLISHED, SCHEDULED, SCHEDULED_AB, SCHEDULED_OR_PUBLISHED |
currentlyPublished | boolean | Required within parent | Indicates whether the page is currently published. |
domain | string | Required within parent | The domain this page will resolve to. If null, the page will default to the primary domain for this content type. |
dynamicPageDataSourceId | string | Required within parent | The identifier for the data source used by the dynamic page. |
dynamicPageDataSourceType | integer | Required within parent | The type of data source used by the dynamic page. Format: int32 |
dynamicPageHubDbTableId | string | Required within parent | The ID of the HubDB table this page references, if applicable |
enableDomainStylesheets | boolean | Required within parent | Boolean to determine whether or not the styles from the template should be applied. |
enableLayoutStylesheets | boolean | Required within parent | Boolean to determine whether or not the styles from the template should be applied. |
featuredImage | string | Required within parent | The featuredImage of this page. |
featuredImageAltText | string | Required within parent | Alt Text of the featuredImage. |
folderId | string | Required within parent | The ID of the associated folder this landing page is organized under in the app dashboard. |
footerHtml | string | Required within parent | Custom HTML for embed codes, javascript that should be placed before the </body> tag of the page. |
headHtml | string | Required within parent | Custom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page. |
htmlTitle | string | Required within parent | The html title of this page. |
id | string | Required within parent | The unique ID of the page. |
includeDefaultCustomCss | boolean | Required within parent | Boolean to determine whether or not the Primary CSS Files should be applied. |
language | string | Required within parent | The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain. One of: aa, ab, ae, af, af-na, af-za, agq, agq-cm, ak, ak-gh, am, am-et, an, ann, ann-ng, ar, ar-001, ar-ae, ar-bh, ar-dj, ar-dz, ar-eg, ar-eh, ar-er, ar-il, ar-iq, ar-jo, ar-km, ar-kw, ar-lb, ar-ly, ar-ma, ar-mr, ar-om, ar-ps, ar-qa, ar-sa, ar-sd, ar-so, ar-ss, ar-sy, ar-td, ar-tn, ar-ye, as, as-in, asa, asa-tz, ast, ast-es, av, ay, az, az-az, ba, bal, bal-pk, bas, bas-cm, be, be-by, bem, bem-zm, bez, bez-tz, bg, bg-bg, bgc, bgc-in, bho, bho-in, bi, blo, blo-bj, bm, bm-ml, bn, bn-bd, bn-in, bo, bo-cn, bo-in, br, br-fr, brx, brx-in, bs, bs-ba, ca, ca-ad, ca-es, ca-fr, ca-it, ccp, ccp-bd, ccp-in, ce, ce-ru, ceb, ceb-ph, cgg, cgg-ug, ch, chr, chr-us, ckb, ckb-iq, ckb-ir, co, cr, cs, cs-cz, csw, csw-ca, cu, cu-ru, cv, cv-ru, cy, cy-gb, da, da-dk, da-gl, dav, dav-ke, de, de-at, de-be, de-ch, de-de, de-gr, de-it, de-li, de-lu, dje, dje-ne, doi, doi-in, dsb, dsb-de, dua, dua-cm, dv, dyo, dyo-sn, dz, dz-bt, ebu, ebu-ke, ee, ee-gh, ee-tg, el, el-cy, el-gr, en, en-001, en-150, en-ae, en-ag, en-ai, en-as, en-at, en-au, en-bb, en-be, en-bi, en-bm, en-bs, en-bw, en-bz, en-ca, en-cc, en-ch, en-ck, en-cm, en-cn, en-cx, en-cy, en-cz, en-de, en-dg, en-dk, en-dm, en-ee, en-eg, en-er, en-es, en-fi, en-fj, en-fk, en-fm, en-fr, en-gb, en-gd, en-gg, en-gh, en-gi, en-gm, en-gs, en-gu, en-gy, en-hk, en-hu, en-id, en-ie, en-il, en-im, en-in, en-io, en-it, en-je, en-jm, en-ke, en-ki, en-kn, en-ky, en-lc, en-lr, en-ls, en-lu, en-mg, en-mh, en-mo, en-mp, en-ms, en-mt, en-mu, en-mv, en-mw, en-mx, en-my, en-na, en-nf, en-ng, en-nl, en-no, en-nr, en-nu, en-nz, en-pg, en-ph, en-pk, en-pl, en-pn, en-pr, en-pt, en-pw, en-ro, en-rw, en-sb, en-sc, en-sd, en-se, en-sg, en-sh, en-si, en-sk, en-sl, en-ss, en-sx, en-sz, en-tc, en-th, en-tk, en-tn, en-to, en-tt, en-tv, en-tz, en-ug, en-um, en-us, en-vc, en-vg, en-vi, en-vn, en-vu, en-ws, en-za, en-zm, en-zw, eo, eo-001, es, es-419, es-ar, es-bo, es-br, es-bz, es-cl, es-co, es-cr, es-cu, es-do, es-ea, es-ec, es-es, es-gq, es-gt, es-hn, es-ic, es-mx, es-ni, es-pa, es-pe, es-ph, es-pr, es-py, es-sv, es-us, es-uy, es-ve, et, et-ee, eu, eu-es, ewo, ewo-cm, fa, fa-af, fa-ir, ff, ff-bf, ff-cm, ff-gh, ff-gm, ff-gn, ff-gw, ff-lr, ff-mr, ff-ne, ff-ng, ff-sl, ff-sn, fi, fi-fi, fil, fil-ph, fj, fo, fo-dk, fo-fo, fr, fr-be, fr-bf, fr-bi, fr-bj, fr-bl, fr-ca, fr-cd, fr-cf, fr-cg, fr-ch, fr-ci, fr-cm, fr-dj, fr-dz, fr-fr, fr-ga, fr-gf, fr-gn, fr-gp, fr-gq, fr-ht, fr-km, fr-lu, fr-ma, fr-mc, fr-mf, fr-mg, fr-ml, fr-mq, fr-mr, fr-mu, fr-nc, fr-ne, fr-pf, fr-pm, fr-re, fr-rw, fr-sc, fr-sn, fr-sy, fr-td, fr-tg, fr-tn, fr-vu, fr-wf, fr-yt, frr, frr-de, fur, fur-it, fy, fy-nl, ga, ga-gb, ga-ie, gaa, gaa-gh, gd, gd-gb, gl, gl-es, gn, gsw, gsw-ch, gsw-fr, gsw-li, gu, gu-in, guz, guz-ke, gv, gv-im, ha, ha-gh, ha-ne, ha-ng, haw, haw-us, he, he-il, hi, hi-in, hmn, ho, hr, hr-ba, hr-hr, hsb, hsb-de, ht, ht-ht, hu, hu-hu, hy, hy-am, hz, ia, ia-001, id, id-id, ie, ie-ee, ig, ig-ng, ii, ii-cn, ik, io, is, is-is, it, it-ch, it-it, it-sm, it-va, iu, ja, ja-jp, jgo, jgo-cm, jmc, jmc-tz, jv, jv-id, ka, ka-ge, kab, kab-dz, kam, kam-ke, kar, kde, kde-tz, kea, kea-cv, kg, kgp, kgp-br, kh, khq, khq-ml, ki, ki-ke, kj, kk, kk-kz, kkj, kkj-cm, kl, kl-gl, kln, kln-ke, km, km-kh, kn, kn-in, ko, ko-cn, ko-kp, ko-kr, kok, kok-in, kr, ks, ks-in, ksb, ksb-tz, ksf, ksf-cm, ksh, ksh-de, ku, ku-tr, kv, kw, kw-gb, kxv, kxv-in, ky, ky-kg, la, lag, lag-tz, lb, lb-lu, lg, lg-ug, li, lij, lij-it, lkt, lkt-us, lmo, lmo-it, ln, ln-ao, ln-cd, ln-cf, ln-cg, lo, lo-la, lrc, lrc-iq, lrc-ir, lt, lt-lt, lu, lu-cd, luo, luo-ke, luy, luy-ke, lv, lv-lv, mai, mai-in, mas, mas-ke, mas-tz, mdf, mdf-ru, mer, mer-ke, mfe, mfe-mu, mg, mg-mg, mgh, mgh-mz, mgo, mgo-cm, mh, mi, mi-nz, mk, mk-mk, ml, ml-in, mn, mn-mn, mni, mni-in, mr, mr-in, ms, ms-bn, ms-id, ms-my, ms-sg, mt, mt-mt, mua, mua-cm, my, my-mm, mzn, mzn-ir, na, naq, naq-na, nb, nb-no, nb-sj, nd, nd-zw, nds, nds-de, nds-nl, ne, ne-in, ne-np, ng, nl, nl-aw, nl-be, nl-bq, nl-ch, nl-cw, nl-lu, nl-nl, nl-sr, nl-sx, nmg, nmg-cm, nn, nn-no, nnh, nnh-cm, no, no-no, nqo, nqo-gn, nr, nso, nso-za, nus, nus-ss, nv, ny, nyn, nyn-ug, oc, oc-es, oc-fr, oj, om, om-et, om-ke, or, or-in, os, os-ge, os-ru, pa, pa-in, pa-pk, pcm, pcm-ng, pi, pis, pis-sb, pl, pl-pl, prg, prg-001, ps, ps-af, ps-pk, pt, pt-ao, pt-br, pt-ch, pt-cv, pt-gq, pt-gw, pt-lu, pt-mo, pt-mz, pt-pt, pt-st, pt-tl, qu, qu-bo, qu-ec, qu-pe, raj, raj-in, rm, rm-ch, rn, rn-bi, ro, ro-md, ro-ro, rof, rof-tz, ru, ru-by, ru-kg, ru-kz, ru-md, ru-ru, ru-ua, rw, rw-rw, rwk, rwk-tz, sa, sa-in, sah, sah-ru, saq, saq-ke, sat, sat-in, sbp, sbp-tz, sc, sc-it, sd, sd-in, sd-pk, se, se-fi, se-no, se-se, seh, seh-mz, ses, ses-ml, sg, sg-cf, shi, shi-ma, si, si-lk, sk, sk-sk, sl, sl-si, sm, smn, smn-fi, sms, sms-fi, sn, sn-zw, so, so-dj, so-et, so-ke, so-so, sq, sq-al, sq-mk, sq-xk, sr, sr-ba, sr-cs, sr-me, sr-rs, sr-xk, ss, st, st-ls, st-za, su, su-id, sv, sv-ax, sv-fi, sv-se, sw, sw-cd, sw-ke, sw-tz, sw-ug, sy, syr, syr-iq, syr-sy, szl, szl-pl, ta, ta-in, ta-lk, ta-my, ta-sg, te, te-in, teo, teo-ke, teo-ug, tg, tg-tj, th, th-th, ti, ti-er, ti-et, tk, tk-tm, tl, tn, tn-bw, tn-za, to, to-to, tok, tok-001, tr, tr-cy, tr-tr, ts, tt, tt-ru, tw, twq, twq-ne, ty, tzm, tzm-ma, ug, ug-cn, uk, uk-ua, ur, ur-in, ur-pk, uz, uz-af, uz-uz, vai, vai-lr, ve, vec, vec-it, vi, vi-vn, vmw, vmw-mz, vo, vo-001, vun, vun-tz, wa, wae, wae-ch, wo, wo-sn, xh, xh-za, xnr, xnr-in, xog, xog-ug, yav, yav-cm, yi, yi-001, yi-ua, yo, yo-bj, yo-ng, yrl, yrl-br, yrl-co, yrl-ve, yue, yue-cn, yue-hk, yue-mo, za, za-cn, zgh, zgh-ma, zh, zh-cn, zh-hans, zh-hant, zh-hk, zh-mo, zh-my, zh-sg, zh-tw, zu, zu-za |
layoutSections | object | Required within parent | A structure detailing the layout sections of the page. Additional keys: see wildcard field |
layoutSections.* | Model | Additional keys | Expand Create a landing page — request body — body layout Sections value |
linkRelCanonicalUrl | string | Required within parent | Optional override to set the URL to be used in the rel=canonical link tag on the page. |
mabExperimentId | string | Required within parent | The ID of the MAB test (or dynamic test) associated with this page, if applicable |
metaDescription | string | Required within parent | A description that goes in <meta> tag on the page. |
name | string | Required within parent | The internal name of the page. |
pageExpiryDate | integer | Required within parent | The date at which this page should expire and begin redirecting to another url or page. Format: int64 |
pageExpiryEnabled | boolean | Required within parent | Boolean describing if the page expiration feature is enabled for this page |
pageExpiryRedirectId | integer | Required within parent | The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl. Format: int64 |
pageExpiryRedirectUrl | string | Required within parent | The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId. |
pageRedirected | boolean | Required within parent | A generated Boolean describing whether or not this page is currently expired and being redirected. |
password | string | Required within parent | Set this to create a password protected page. Entering the password will be required to view the page. |
publicAccessRules | array | Required within parent | Rules for require member registration to access private content. |
publicAccessRules[] | Model | Each item | Expand List tags — response body |
publicAccessRulesEnabled | boolean | Required within parent | Boolean to determine whether or not to respect publicAccessRules. |
publishDate | string | Required within parent | The date (ISO8601 format) the page is to be published at. Format: date-time |
publishImmediately | boolean | Required within parent | Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting. |
slug | string | Required within parent | The path of the this page. This field is appended to the domain to construct the url of this page. |
state | string | Required within parent | An ENUM descibing the current state of this page. Maximum length: 25 |
subcategory | string | Required within parent | Details the type of page this is. Should always be landing_page or site_page |
templatePath | string | Required within parent | String detailing the path of the template used for this page. |
themeSettingsValues | object | Required within parent | A collection of settings specific to the theme applied to the page. Additional keys: see wildcard field |
themeSettingsValues.* | object | Additional keys | |
translatedFromId | string | Required within parent | ID of the primary page this object was translated from. |
translations | object | Required within parent | A map of translations for the page, each associated with a specific language variation. Additional keys: see wildcard field |
translations.* | Model | Additional keys | Expand Create a landing page — request body — body translations value |
updated | string | Required within parent | The timestamp indicating when the page was last updated. Format: date-time |
updatedById | string | Required within parent | The ID of the user that updated this page. |
url | string | Required within parent | A generated field representing the URL of this page. |
useFeaturedImage | boolean | Required within parent | Boolean to determine if this page should use a featuredImage. |
widgetContainers | object | Required within parent | A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers. Additional keys: see wildcard field |
widgetContainers.* | object | Additional keys | |
widgets | object | Required within parent | A data structure containing the data for all the modules for this page. Additional keys: see wildcard field |
widgets.* | object | Additional keys |
Referenced models: List tags — response body, Create a landing page — request body — body translations value, Create a landing page — request body — body layout Sections value
Create a landing page — request body — body layout Sections value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells | array | Required within parent | The individual cells within the section, each representing a distinct area for content placement. |
cells[] | Model | Each item | Expand Create a landing page — request body — body layout Sections value |
cssClass | string | Required within parent | The CSS class applied to the layout section. |
cssId | string | Required within parent | The CSS ID applied to the layout section. |
cssStyle | string | Required within parent | Custom CSS styles applied to the layout section. |
label | string | Required within parent | The label for the layout section. |
name | string | Required within parent | The internal name of the page. |
params | object | Required within parent | Parameters associated with the layout section. Additional keys: see wildcard field |
params.* | object | Additional keys | |
rowMetaData | array | Required within parent | Metadata about the rows within the section, such as styling or configuration details. |
rowMetaData[] | Model | Each item | Expand Create a landing page — request body — body layout Sections value row Meta Data item |
rows | array | Required within parent | The number of rows contained within the section, used to organize content vertically. |
rows[] | object | Each item | Additional keys: see wildcard field |
rows[].* | Model | Additional keys | Expand Create a landing page — request body — body layout Sections value |
styles | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles |
type | string | Required within parent | The type of the layout section. |
w | integer | Required within parent | The width of the layout section. Format: int32 |
x | integer | Required within parent | The x-coordinate position of the layout section. Format: int32 |
Referenced models: Create a landing page — request body — body layout Sections value, Create a landing page — request body — body layout Sections value row Meta Data item, Create a landing page — request body — body layout Sections value styles
Create a landing page — request body — body layout Sections value row Meta Data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cssClass | string | Required within parent | The CSS class applied to the row metadata. |
styles | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles |
Referenced models: Create a landing page — request body — body layout Sections value styles
Create a landing page — request body — body layout Sections value styles
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
backgroundColor | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles background Color |
backgroundGradient | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles background Gradient |
backgroundImage | Model | Required within parent | Expand Update a post — response body — layout Sections value styles background Image |
breakpointStyles | object | Optional | Contains style settings specific to different breakpoints. This property allows for responsive design adjustments based on screen size. Additional keys: see wildcard field |
breakpointStyles.* | Model | Additional keys | Expand Create a landing page — request body — body layout Sections value styles breakpoint Styles value |
flexboxPositioning | string | Required within parent | Indicates whether flexbox positioning is enabled for the section. One of: BOTTOM_CENTER, BOTTOM_LEFT, BOTTOM_RIGHT, MIDDLE_CENTER, MIDDLE_LEFT, MIDDLE_RIGHT, TOP_CENTER, TOP_LEFT, TOP_RIGHT |
forceFullWidthSection | boolean | Required within parent | Determines if the section should be forced to full width. |
maxWidthSectionCentering | integer | Required within parent | Defines the maximum width for centering the section. Format: int32 |
verticalAlignment | string | Required within parent | Specifies the vertical alignment of elements within the section. One of: BOTTOM, MIDDLE, TOP |
Referenced models: Update a post — response body — layout Sections value styles background Image, Create a landing page — request body — body layout Sections value styles breakpoint Styles value, Create a landing page — request body — body layout Sections value styles background Gradient, Update a post — request body — body layout Sections value styles background Color
Create a landing page — request body — body layout Sections value styles background Gradient
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
angle | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles background Gradient angle |
colors | array | Required within parent | An array of color values that make up the gradient. Each color is applied in sequence to create the gradient effect. |
colors[] | Model | Each item | Expand Update a post — request body — body layout Sections value styles background Gradient colors item |
sideOrCorner | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles background Gradient side Or Corner |
Referenced models: Update a post — request body — body layout Sections value styles background Gradient angle, Update a post — request body — body layout Sections value styles background Gradient colors item, Update a post — request body — body layout Sections value styles background Gradient side Or Corner
Create a landing page — request body — body layout Sections value styles breakpoint Styles value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hidden | boolean | Required within parent | A boolean indicating whether the element should be hidden at this breakpoint. A value of true means the element is not visible. |
margin | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin |
padding | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles breakpoint Styles value padding |
Referenced models: Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin, Create a landing page — request body — body layout Sections value styles breakpoint Styles value padding
Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bottom | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin top |
top | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin top |
Referenced models: Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin top
Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin top
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
units | string | Required within parent | A string indicating the unit of measurement for the size value, such as 'pixels', 'inches', or 'centimeters'. One of: CH, CM, EM, EX, IN, LH, MM, PC, PERCENTAGE, PT, PX, Q, REM, VH, VMAX, VMIN, VW |
value | number | Required within parent | A numerical value representing the size dimension of the object. The data type is a number. |
Create a landing page — request body — body layout Sections value styles breakpoint Styles value padding
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bottom | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin top |
left | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin top |
right | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin top |
top | Model | Required within parent | Expand Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin top |
Referenced models: Create a landing page — request body — body layout Sections value styles breakpoint Styles value margin top
Create a landing page — request body — body translations value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archivedInDashboard | boolean | Required within parent | Indicates if the page is hidden from the dashboard, though it may still be live. |
authorName | string | Required within parent | The name of the user that updated this page. |
campaign | string | Required within parent | The GUID of the marketing campaign this page is a part of. |
campaignName | string | Required within parent | The name of the campaign associated with this language variation. |
created | string | Required within parent | The date and time when the content language variation was created. Format: date-time |
id | integer | Required within parent | ID of object to set as primary in multi-language group. Format: int64 |
name | string | Required within parent | The internal name of the page. |
password | string | Required within parent | A password required to view the page, if set. |
publicAccessRules | array | Required within parent | A list of rules defining public access permissions for this language variation. |
publicAccessRules[] | Model | Each item | Expand List tags — response body |
publicAccessRulesEnabled | boolean | Required within parent | Determines if public access rules should be respected. |
publishDate | string | Required within parent | The date and time when the page is scheduled to be published. Format: date-time |
slug | string | Required within parent | The path of this page, appended to the domain to construct the URL. |
state | string | Required within parent | An ENUM descibing the current state of this page. |
tagIds | array | Optional | A list of tag IDs associated with this language variation. |
tagIds[] | integer | Each item | Format: int64 |
updated | string | Required within parent | The date and time when the content language variation was last updated. Format: date-time |
Referenced models: List tags — response body
Create a new A B test variation — pages landing Pages Ab Tests Create Variation — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contentId | string | Required within parent | ID of the object to test. |
variationName | string | Required within parent | Name of A/B test variation. |
Create a new language variation — pages landing Pages Multi Language Create Language Variation — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | ID of content to clone. |
language | string | Optional | Target language of new variant. |
primaryLanguage | string | Optional | Language of primary content to clone. |
usePublished | boolean | Optional | A boolean indicating whether the published version of the page should be used for creating the language variation. If true, the published version is used; otherwise, the draft version is used. |
Create folders — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | array | Required within parent | Content folders to input. |
inputs[] | Model | Each item | Expand Create a landing page folder — request body — body |
Referenced models: Create a landing page folder — request body — body
Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Ye olde error |
category | string | Required within parent | Error category. |
context | object | Required within parent | Error context. Additional keys: see wildcard field |
context.* | array | Additional keys | |
context.*[] | string | Each item | |
errors | array | Required within parent | List of error details. |
errors[] | Model | Each item | Expand Batch insert events — response body — errors item errors item |
id | string | Optional | Error ID. |
links | object | Required within parent | Error links. Additional keys: see wildcard field |
links.* | string | Additional keys | |
message | string | Required within parent | Error message. |
status | string | Required within parent | Error status. |
subCategory | object | Optional | Error subcategory. |
Referenced models: Batch insert events — response body — errors item errors item
Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Content Folder
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completedAt | string | Required within parent | Time of batch operation completion. Format: date-time |
links | object | Optional | Links associated with batch operation. Additional keys: see wildcard field |
links.* | string | Additional keys | |
requestedAt | string | Optional | Time of batch operation request. Format: date-time |
results | array | Required within parent | Results of batch operation. |
results[] | Model | Each item | Expand Create a landing page folder — response body |
startedAt | string | Required within parent | Time of batch operation start. Format: date-time |
status | string | Required within parent | Status of batch operation. Known values: CANCELED, COMPLETE, PENDING, PROCESSING |
Referenced models: Create a landing page folder — response body
Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Content Folder With Errors
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completedAt | string | Required within parent | Time of batch operation completion. Format: date-time |
errors | array | Optional | Errors in batch operation. |
errors[] | Model | Each item | Expand Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item |
links | object | Optional | Links associated with batch operation. Additional keys: see wildcard field |
links.* | string | Additional keys | |
numErrors | JSON | Optional | |
numErrors (anyOf 1) | integer | Alternative | Number of errors. Format: int32 |
numErrors (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestedAt | string | Optional | Time of batch operation request. Format: date-time |
results | array | Required within parent | Results of batch operation. |
results[] | Model | Each item | Expand Create a landing page folder — response body |
startedAt | string | Required within parent | Time of batch operation start. Format: date-time |
status | string | Required within parent | Status of batch operation. Known values: CANCELED, COMPLETE, PENDING, PROCESSING |
Referenced models: Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create a landing page folder — response body
Create landing pages — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | array | Required within parent | Pages to input. |
inputs[] | Model | Each item | Expand Create a landing page — request body — body |
Referenced models: Create a landing page — request body — body
Create landing pages — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completedAt | string | Required within parent | Time of batch operation completion. Format: date-time |
links | object | Optional | Links associated with batch operation. Additional keys: see wildcard field |
links.* | string | Additional keys | |
requestedAt | string | Optional | Time of batch operation request. Format: date-time |
results | array | Required within parent | Results of batch operation. |
results[] | Model | Each item | Expand Clone a landing page — response body |
startedAt | string | Required within parent | Time of batch operation start. Format: date-time |
status | string | Required within parent | Status of batch operation. Known values: CANCELED, COMPLETE, PENDING, PROCESSING |
Referenced models: Clone a landing page — response body
Create landing pages — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Page With Errors
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completedAt | string | Required within parent | Time of batch operation completion. Format: date-time |
errors | array | Optional | Errors in batch operation. |
errors[] | Model | Each item | Expand Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item |
links | object | Optional | Links associated with batch operation. Additional keys: see wildcard field |
links.* | string | Additional keys | |
numErrors | JSON | Optional | |
numErrors (anyOf 1) | integer | Alternative | Number of errors. Format: int32 |
numErrors (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestedAt | string | Optional | Time of batch operation request. Format: date-time |
results | array | Required within parent | Results of batch operation. |
results[] | Model | Each item | Expand Clone a landing page — response body |
startedAt | string | Required within parent | Time of batch operation start. Format: date-time |
status | string | Required within parent | Status of batch operation. Known values: CANCELED, COMPLETE, PENDING, PROCESSING |
Referenced models: Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Clone a landing page — response body
Delete folders — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | array | Required within parent | Strings to input. |
inputs[] | string | Each item |
End an active A B test — pages landing Pages End Ab Test — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
abTestId | string | Required within parent | ID of the test to end. |
winnerId | string | Required within parent | ID of the object to designate as the test winner. |
Get all landing page folders — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Get all landing pages — response body — paging |
results | array | Required within parent | Collection of content folders. |
results[] | Model | Each item | Expand Create a landing page folder — response body |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Total number of content folders. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Create a landing page folder — response body, Get all landing pages — response body — paging
Get all landing pages — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Get all landing pages — response body — paging |
results | array | Required within parent | Collection of pages. |
results[] | Model | Each item | Expand Clone a landing page — response body |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Total number of pages. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Clone a landing page — response body, Get all landing pages — response body — paging
Get all landing pages — response body — paging
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page. |
next | Model | Optional | Expand Get all landing pages — response body — paging next |
Referenced models: Get all landing pages — response body — paging next
Get all landing pages — response body — paging next
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies the paging information needed to retrieve the next set of results in a paginated API response |
after | string | Required within parent | A string that serves as the paging cursor token, indicating the position after the last successfully read resource. It is used to fetch the next set of results in a paginated response. |
link | string | Optional | A string containing the URL link to the next page of results in a paginated response. |
Rerun a previous A B test — pages landing Pages Rerun Ab Test — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
abTestId | string | Required within parent | ID of the test to rerun. |
variationId | string | Required within parent | ID of the object to reactivate as a test variation. |
Retrieve a previous version of a folder — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier for this version of the content folder. |
object | Model | Required within parent | Expand Create a landing page folder — response body |
updatedAt | string | Required within parent | The date and time when this version was last updated, in ISO 8601 format. Format: date-time |
user | Model | Required within parent | Expand Get a revision of a marketing email — response body — user |
Referenced models: Get a revision of a marketing email — response body — user, Create a landing page folder — response body
Retrieve a previous version of a landing page — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier for this specific version of the page. |
object | Model | Required within parent | Expand Clone a landing page — response body |
updatedAt | string | Required within parent | The date and time when this version was last updated, in ISO 8601 format. Format: date-time |
user | Model | Required within parent | Expand Get a revision of a marketing email — response body — user |
Referenced models: Get a revision of a marketing email — response body — user, Clone a landing page — response body
Retrieve all previous versions of a landing page — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Retrieves previous versions of a folder — response body — paging |
results | array | Required within parent | An array containing the individual items or results of the collection. |
results[] | Model | Each item | Expand Retrieve a previous version of a landing page — response body |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | An integer representing the total number of items in the collection. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve a previous version of a landing page — response body, Retrieves previous versions of a folder — response body — paging
Retrieves previous versions of a folder — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Retrieves previous versions of a folder — response body — paging |
results | array | Required within parent | An array containing the content folder version objects returned in the current response. |
results[] | Model | Each item | Expand Retrieve a previous version of a folder — response body |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | An integer representing the total number of content folder versions available. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve a previous version of a folder — response body, Retrieves previous versions of a folder — response body — paging
Retrieves previous versions of a folder — response body — paging
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results. |
next | Model | Optional | Expand Get all landing pages — response body — paging next |
prev | Model | Optional | Expand Retrieves previous versions of a folder — response body — paging prev |
Referenced models: Get all landing pages — response body — paging next, Retrieves previous versions of a folder — response body — paging prev
Retrieves previous versions of a folder — response body — paging prev
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | specifies the paging information needed to retrieve the previous set of results in a paginated API response |
before | string | Required within parent | A string token used as a cursor to retrieve the previous set of results in a paginated response. |
link | string | Optional | A URL that provides access to the previous page of results in a paginated response. |
Update a landing page folder — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | integer | Optional | The type of object this folder applies to. Should always be LANDING_PAGE. Format: int32 |
created | string | Optional | The timestamp indicating when the content folder was created. Format: date-time |
deletedAt | string | Optional | The timestamp (ISO8601 format) when this content folder was deleted. Format: date-time |
id | string | Optional | The unique ID of the content folder. |
name | string | Optional | The name of the folder which will show up in the app dashboard |
parentFolderId | integer | Optional | The ID of the content folder this folder is nested under Format: int64 |
updated | string | Optional | The timestamp indicating when the content folder was last updated. Format: date-time |
Update a landing page — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
abStatus | string | Optional | The status of the AB test associated with this page, if applicable One of: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant |
abTestId | string | Optional | The ID of the AB test associated with this page, if applicable |
archivedAt | string | Optional | The timestamp when this page was deleted. Format: date-time |
archivedInDashboard | boolean | Optional | If True, the page will not show up in your dashboard, although the page could still be live. |
attachedStylesheets | array | Optional | List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML. |
attachedStylesheets[] | object | Each item | Additional keys: see wildcard field |
attachedStylesheets[].* | object | Additional keys | |
authorName | string | Optional | The name of the user that updated this page. |
campaign | string | Optional | The GUID of the marketing campaign this page is a part of. |
categoryId | integer | Optional | ID of the type of object this is. Should always . Format: int32 |
contentGroupId | string | Optional | Required when creating or cloning blog posts. The unique identifier for the content group associated with the blog. |
contentTypeCategory | string | Optional | An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE. One of: 0, 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 3, 4, 5, 6, 7, 8, 9 |
created | string | Optional | The timestamp indicating when the page was created. Format: date-time |
createdById | string | Optional | The ID of the user that created this page. |
currentState | string | Optional | A generated ENUM descibing the current state of this page. One of: AGENT_GENERATED, AUTOMATED, AUTOMATED_AB, AUTOMATED_AB_VARIANT, AUTOMATED_DRAFT, AUTOMATED_DRAFT_AB, AUTOMATED_DRAFT_ABVARIANT, AUTOMATED_FOR_FORM, AUTOMATED_FOR_FORM_BUFFER, AUTOMATED_FOR_FORM_DRAFT, AUTOMATED_FOR_FORM_LEGACY, AUTOMATED_LOSER_ABVARIANT, AUTOMATED_SENDING, BLOG_EMAIL_DRAFT, BLOG_EMAIL_PUBLISHED, DRAFT, DRAFT_AB, DRAFT_AB_VARIANT, ERROR, LOSER_AB_VARIANT, PAGE_STUB, PRE_PROCESSING, PROCESSING, PUBLISHED, PUBLISHED_AB, PUBLISHED_AB_VARIANT, PUBLISHED_OR_SCHEDULED, RSS_TO_EMAIL_DRAFT, RSS_TO_EMAIL_PUBLISHED, SCHEDULED, SCHEDULED_AB, SCHEDULED_OR_PUBLISHED |
currentlyPublished | boolean | Optional | Indicates whether the page is currently published. |
domain | string | Optional | The domain this page will resolve to. If null, the page will default to the primary domain for this content type. |
dynamicPageDataSourceId | string | Optional | The identifier for the data source used by the dynamic page. |
dynamicPageDataSourceType | integer | Optional | The type of data source used by the dynamic page. Format: int32 |
dynamicPageHubDbTableId | string | Optional | The ID of the HubDB table this page references, if applicable |
enableDomainStylesheets | boolean | Optional | Boolean to determine whether or not the styles from the template should be applied. |
enableLayoutStylesheets | boolean | Optional | Boolean to determine whether or not the styles from the template should be applied. |
featuredImage | string | Optional | The featuredImage of this page. |
featuredImageAltText | string | Optional | Alt Text of the featuredImage. |
folderId | string | Optional | The ID of the associated folder this landing page is organized under in the app dashboard. |
footerHtml | string | Optional | Custom HTML for embed codes, javascript that should be placed before the </body> tag of the page. |
headHtml | string | Optional | Custom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page. |
htmlTitle | string | Optional | The html title of this page. |
id | string | Optional | The unique ID of the page. |
includeDefaultCustomCss | boolean | Optional | Boolean to determine whether or not the Primary CSS Files should be applied. |
language | string | Optional | The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain. One of: aa, ab, ae, af, af-na, af-za, agq, agq-cm, ak, ak-gh, am, am-et, an, ann, ann-ng, ar, ar-001, ar-ae, ar-bh, ar-dj, ar-dz, ar-eg, ar-eh, ar-er, ar-il, ar-iq, ar-jo, ar-km, ar-kw, ar-lb, ar-ly, ar-ma, ar-mr, ar-om, ar-ps, ar-qa, ar-sa, ar-sd, ar-so, ar-ss, ar-sy, ar-td, ar-tn, ar-ye, as, as-in, asa, asa-tz, ast, ast-es, av, ay, az, az-az, ba, bal, bal-pk, bas, bas-cm, be, be-by, bem, bem-zm, bez, bez-tz, bg, bg-bg, bgc, bgc-in, bho, bho-in, bi, blo, blo-bj, bm, bm-ml, bn, bn-bd, bn-in, bo, bo-cn, bo-in, br, br-fr, brx, brx-in, bs, bs-ba, ca, ca-ad, ca-es, ca-fr, ca-it, ccp, ccp-bd, ccp-in, ce, ce-ru, ceb, ceb-ph, cgg, cgg-ug, ch, chr, chr-us, ckb, ckb-iq, ckb-ir, co, cr, cs, cs-cz, csw, csw-ca, cu, cu-ru, cv, cv-ru, cy, cy-gb, da, da-dk, da-gl, dav, dav-ke, de, de-at, de-be, de-ch, de-de, de-gr, de-it, de-li, de-lu, dje, dje-ne, doi, doi-in, dsb, dsb-de, dua, dua-cm, dv, dyo, dyo-sn, dz, dz-bt, ebu, ebu-ke, ee, ee-gh, ee-tg, el, el-cy, el-gr, en, en-001, en-150, en-ae, en-ag, en-ai, en-as, en-at, en-au, en-bb, en-be, en-bi, en-bm, en-bs, en-bw, en-bz, en-ca, en-cc, en-ch, en-ck, en-cm, en-cn, en-cx, en-cy, en-cz, en-de, en-dg, en-dk, en-dm, en-ee, en-eg, en-er, en-es, en-fi, en-fj, en-fk, en-fm, en-fr, en-gb, en-gd, en-gg, en-gh, en-gi, en-gm, en-gs, en-gu, en-gy, en-hk, en-hu, en-id, en-ie, en-il, en-im, en-in, en-io, en-it, en-je, en-jm, en-ke, en-ki, en-kn, en-ky, en-lc, en-lr, en-ls, en-lu, en-mg, en-mh, en-mo, en-mp, en-ms, en-mt, en-mu, en-mv, en-mw, en-mx, en-my, en-na, en-nf, en-ng, en-nl, en-no, en-nr, en-nu, en-nz, en-pg, en-ph, en-pk, en-pl, en-pn, en-pr, en-pt, en-pw, en-ro, en-rw, en-sb, en-sc, en-sd, en-se, en-sg, en-sh, en-si, en-sk, en-sl, en-ss, en-sx, en-sz, en-tc, en-th, en-tk, en-tn, en-to, en-tt, en-tv, en-tz, en-ug, en-um, en-us, en-vc, en-vg, en-vi, en-vn, en-vu, en-ws, en-za, en-zm, en-zw, eo, eo-001, es, es-419, es-ar, es-bo, es-br, es-bz, es-cl, es-co, es-cr, es-cu, es-do, es-ea, es-ec, es-es, es-gq, es-gt, es-hn, es-ic, es-mx, es-ni, es-pa, es-pe, es-ph, es-pr, es-py, es-sv, es-us, es-uy, es-ve, et, et-ee, eu, eu-es, ewo, ewo-cm, fa, fa-af, fa-ir, ff, ff-bf, ff-cm, ff-gh, ff-gm, ff-gn, ff-gw, ff-lr, ff-mr, ff-ne, ff-ng, ff-sl, ff-sn, fi, fi-fi, fil, fil-ph, fj, fo, fo-dk, fo-fo, fr, fr-be, fr-bf, fr-bi, fr-bj, fr-bl, fr-ca, fr-cd, fr-cf, fr-cg, fr-ch, fr-ci, fr-cm, fr-dj, fr-dz, fr-fr, fr-ga, fr-gf, fr-gn, fr-gp, fr-gq, fr-ht, fr-km, fr-lu, fr-ma, fr-mc, fr-mf, fr-mg, fr-ml, fr-mq, fr-mr, fr-mu, fr-nc, fr-ne, fr-pf, fr-pm, fr-re, fr-rw, fr-sc, fr-sn, fr-sy, fr-td, fr-tg, fr-tn, fr-vu, fr-wf, fr-yt, frr, frr-de, fur, fur-it, fy, fy-nl, ga, ga-gb, ga-ie, gaa, gaa-gh, gd, gd-gb, gl, gl-es, gn, gsw, gsw-ch, gsw-fr, gsw-li, gu, gu-in, guz, guz-ke, gv, gv-im, ha, ha-gh, ha-ne, ha-ng, haw, haw-us, he, he-il, hi, hi-in, hmn, ho, hr, hr-ba, hr-hr, hsb, hsb-de, ht, ht-ht, hu, hu-hu, hy, hy-am, hz, ia, ia-001, id, id-id, ie, ie-ee, ig, ig-ng, ii, ii-cn, ik, io, is, is-is, it, it-ch, it-it, it-sm, it-va, iu, ja, ja-jp, jgo, jgo-cm, jmc, jmc-tz, jv, jv-id, ka, ka-ge, kab, kab-dz, kam, kam-ke, kar, kde, kde-tz, kea, kea-cv, kg, kgp, kgp-br, kh, khq, khq-ml, ki, ki-ke, kj, kk, kk-kz, kkj, kkj-cm, kl, kl-gl, kln, kln-ke, km, km-kh, kn, kn-in, ko, ko-cn, ko-kp, ko-kr, kok, kok-in, kr, ks, ks-in, ksb, ksb-tz, ksf, ksf-cm, ksh, ksh-de, ku, ku-tr, kv, kw, kw-gb, kxv, kxv-in, ky, ky-kg, la, lag, lag-tz, lb, lb-lu, lg, lg-ug, li, lij, lij-it, lkt, lkt-us, lmo, lmo-it, ln, ln-ao, ln-cd, ln-cf, ln-cg, lo, lo-la, lrc, lrc-iq, lrc-ir, lt, lt-lt, lu, lu-cd, luo, luo-ke, luy, luy-ke, lv, lv-lv, mai, mai-in, mas, mas-ke, mas-tz, mdf, mdf-ru, mer, mer-ke, mfe, mfe-mu, mg, mg-mg, mgh, mgh-mz, mgo, mgo-cm, mh, mi, mi-nz, mk, mk-mk, ml, ml-in, mn, mn-mn, mni, mni-in, mr, mr-in, ms, ms-bn, ms-id, ms-my, ms-sg, mt, mt-mt, mua, mua-cm, my, my-mm, mzn, mzn-ir, na, naq, naq-na, nb, nb-no, nb-sj, nd, nd-zw, nds, nds-de, nds-nl, ne, ne-in, ne-np, ng, nl, nl-aw, nl-be, nl-bq, nl-ch, nl-cw, nl-lu, nl-nl, nl-sr, nl-sx, nmg, nmg-cm, nn, nn-no, nnh, nnh-cm, no, no-no, nqo, nqo-gn, nr, nso, nso-za, nus, nus-ss, nv, ny, nyn, nyn-ug, oc, oc-es, oc-fr, oj, om, om-et, om-ke, or, or-in, os, os-ge, os-ru, pa, pa-in, pa-pk, pcm, pcm-ng, pi, pis, pis-sb, pl, pl-pl, prg, prg-001, ps, ps-af, ps-pk, pt, pt-ao, pt-br, pt-ch, pt-cv, pt-gq, pt-gw, pt-lu, pt-mo, pt-mz, pt-pt, pt-st, pt-tl, qu, qu-bo, qu-ec, qu-pe, raj, raj-in, rm, rm-ch, rn, rn-bi, ro, ro-md, ro-ro, rof, rof-tz, ru, ru-by, ru-kg, ru-kz, ru-md, ru-ru, ru-ua, rw, rw-rw, rwk, rwk-tz, sa, sa-in, sah, sah-ru, saq, saq-ke, sat, sat-in, sbp, sbp-tz, sc, sc-it, sd, sd-in, sd-pk, se, se-fi, se-no, se-se, seh, seh-mz, ses, ses-ml, sg, sg-cf, shi, shi-ma, si, si-lk, sk, sk-sk, sl, sl-si, sm, smn, smn-fi, sms, sms-fi, sn, sn-zw, so, so-dj, so-et, so-ke, so-so, sq, sq-al, sq-mk, sq-xk, sr, sr-ba, sr-cs, sr-me, sr-rs, sr-xk, ss, st, st-ls, st-za, su, su-id, sv, sv-ax, sv-fi, sv-se, sw, sw-cd, sw-ke, sw-tz, sw-ug, sy, syr, syr-iq, syr-sy, szl, szl-pl, ta, ta-in, ta-lk, ta-my, ta-sg, te, te-in, teo, teo-ke, teo-ug, tg, tg-tj, th, th-th, ti, ti-er, ti-et, tk, tk-tm, tl, tn, tn-bw, tn-za, to, to-to, tok, tok-001, tr, tr-cy, tr-tr, ts, tt, tt-ru, tw, twq, twq-ne, ty, tzm, tzm-ma, ug, ug-cn, uk, uk-ua, ur, ur-in, ur-pk, uz, uz-af, uz-uz, vai, vai-lr, ve, vec, vec-it, vi, vi-vn, vmw, vmw-mz, vo, vo-001, vun, vun-tz, wa, wae, wae-ch, wo, wo-sn, xh, xh-za, xnr, xnr-in, xog, xog-ug, yav, yav-cm, yi, yi-001, yi-ua, yo, yo-bj, yo-ng, yrl, yrl-br, yrl-co, yrl-ve, yue, yue-cn, yue-hk, yue-mo, za, za-cn, zgh, zgh-ma, zh, zh-cn, zh-hans, zh-hant, zh-hk, zh-mo, zh-my, zh-sg, zh-tw, zu, zu-za |
layoutSections | object | Optional | A structure detailing the layout sections of the page. Additional keys: see wildcard field |
layoutSections.* | Model | Additional keys | Expand Create a landing page — request body — body layout Sections value |
linkRelCanonicalUrl | string | Optional | Optional override to set the URL to be used in the rel=canonical link tag on the page. |
mabExperimentId | string | Optional | The ID of the MAB test (or dynamic test) associated with this page, if applicable |
metaDescription | string | Optional | A description that goes in <meta> tag on the page. |
name | string | Optional | The internal name of the page. |
pageExpiryDate | integer | Optional | The date at which this page should expire and begin redirecting to another url or page. Format: int64 |
pageExpiryEnabled | boolean | Optional | Boolean describing if the page expiration feature is enabled for this page |
pageExpiryRedirectId | integer | Optional | The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl. Format: int64 |
pageExpiryRedirectUrl | string | Optional | The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId. |
pageRedirected | boolean | Optional | A generated Boolean describing whether or not this page is currently expired and being redirected. |
password | string | Optional | Set this to create a password protected page. Entering the password will be required to view the page. |
publicAccessRules | array | Optional | Rules for require member registration to access private content. |
publicAccessRules[] | Model | Each item | Expand List tags — response body |
publicAccessRulesEnabled | boolean | Optional | Boolean to determine whether or not to respect publicAccessRules. |
publishDate | string | Optional | The date (ISO8601 format) the page is to be published at. Format: date-time |
publishImmediately | boolean | Optional | Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting. |
slug | string | Optional | The path of the this page. This field is appended to the domain to construct the url of this page. |
state | string | Optional | An ENUM descibing the current state of this page. Maximum length: 25 |
subcategory | string | Optional | Details the type of page this is. Should always be landing_page or site_page |
templatePath | string | Optional | String detailing the path of the template used for this page. |
themeSettingsValues | object | Optional | A collection of settings specific to the theme applied to the page. Additional keys: see wildcard field |
themeSettingsValues.* | object | Additional keys | |
translatedFromId | string | Optional | ID of the primary page this object was translated from. |
translations | object | Optional | A map of translations for the page, each associated with a specific language variation. Additional keys: see wildcard field |
translations.* | Model | Additional keys | Expand Create a landing page — request body — body translations value |
updated | string | Optional | The timestamp indicating when the page was last updated. Format: date-time |
updatedById | string | Optional | The ID of the user that updated this page. |
url | string | Optional | A generated field representing the URL of this page. |
useFeaturedImage | boolean | Optional | Boolean to determine if this page should use a featuredImage. |
widgetContainers | object | Optional | A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers. Additional keys: see wildcard field |
widgetContainers.* | object | Additional keys | |
widgets | object | Optional | A data structure containing the data for all the modules for this page. Additional keys: see wildcard field |
widgets.* | object | Additional keys |
Referenced models: List tags — response body, Create a landing page — request body — body translations value, Create a landing page — request body — body layout Sections value