HubSpot: Blog posts schemas
47 HubSpot schemas with complete fields and constraints.
← Blog posts operations · All schemas
Clone a blog post — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cloneName | string | Optional | Name of the cloned object. |
id | string | Required within parent | ID of the object to be cloned. |
Create a batch of blog posts — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | array | Required within parent | Blog posts to input. |
inputs[] | Model | Each item | Expand Create a new post — request body — body |
Referenced models: Create a new post — request body — body
Create a batch of blog posts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Blog Post
| 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 Update a post — 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: Update a post — response body
Create a batch of blog posts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Blog Post 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 Update a post — 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, Update a post — response body
Create a language variation — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | ID of blog post to clone. |
language | string | Optional | Target language of new variant. |
usePublished | boolean | Optional | A boolean indicating whether the published version of the blog post should be used for cloning. If true, the published version is used; otherwise, the draft version is used. |
Create a new post — 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 blog post, if applicable Available options: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant 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 | integer | Required within parent | The timestamp (ISO8601 format) when this Blog Post was deleted. Format: int64 |
archivedInDashboard | boolean | Required within parent | If True, the post will not show up in your dashboard, although the post could still be live. |
attachedStylesheets | array | Required within parent | List of stylesheets to attach to this blog post. 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 Blog Post. |
blogAuthorId | string | Required within parent | The ID of the Blog Author associated with this Blog Post. |
campaign | string | Required within parent | The GUID of the marketing campaign this Blog Post 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 | The ID of the parent Blog this Blog Post is associated with. |
contentTypeCategory | string | Required within parent | An ENUM descibing the type of this object. Should always be BLOG_POST. 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 (ISO8601 format) when this Blog Post was created. Format: date-time |
createdById | string | Required within parent | The ID of the user that created this Blog Post. |
currentState | string | Required within parent | A generated ENUM descibing the current state of this Blog Post. Should always match state. One of: AGENT_GENERATED, AUTOMATED, AUTOMATED_AB, AUTOMATED_AB_VARIANT, AUTOMATED_DRAFT, AUTOMATED_DRAFT_AB, AUTOMATED_DRAFT_ABVARIANT, AUTOMATED_FOR_FORM, AUTOMATED_FOR_FORM_BUFFER, AUTOMATED_FOR_FORM_DRAFT, AUTOMATED_FOR_FORM_LEGACY, AUTOMATED_LOSER_ABVARIANT, AUTOMATED_SENDING, BLOG_EMAIL_DRAFT, BLOG_EMAIL_PUBLISHED, DRAFT, DRAFT_AB, DRAFT_AB_VARIANT, ERROR, LOSER_AB_VARIANT, PAGE_STUB, PRE_PROCESSING, PROCESSING, PUBLISHED, PUBLISHED_AB, PUBLISHED_AB_VARIANT, PUBLISHED_OR_SCHEDULED, RSS_TO_EMAIL_DRAFT, RSS_TO_EMAIL_PUBLISHED, SCHEDULED, SCHEDULED_AB, SCHEDULED_OR_PUBLISHED |
currentlyPublished | boolean | Required within parent | Whether the post is published (true or false) |
domain | string | Required within parent | The domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog. |
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 Blog Post references, if applicable |
enableDomainStylesheets | boolean | Required within parent | Boolean to determine whether or not the styles from the template should be applied. |
enableGoogleAmpOutputOverride | boolean | Required within parent | Boolean to allow overriding the AMP settings for the blog. |
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 Blog Post. |
featuredImageAltText | string | Required within parent | Alt Text of the featuredImage. |
folderId | string | Required within parent | Unique identifier of associated folder |
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 Blog Post. |
id | string | Required within parent | The unique ID of the Blog Post. |
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 Blog Post. If null, the Blog Post will default to the language of the ParentBlog. 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 blog post. Additional keys: see wildcard field |
layoutSections.* | Model | Additional keys | Expand Update a post — 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 | Unique identifier of the MAB Experiment |
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 Blog Post. |
pageExpiryDate | integer | Required within parent | The date at which this blog post 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 blog post. |
pageExpiryRedirectId | integer | Required within parent | The ID of another page this blog post's url should redirect to once this blog post expires. Should only set this or pageExpiryRedirectUrl. Format: int64 |
pageExpiryRedirectUrl | string | Required within parent | The URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId. |
password | string | Required within parent | Set this to create a password protected page. Entering the password will be required to view the page. |
postBody | string | Required within parent | The HTML of the main post body. |
postSummary | string | Required within parent | The summary of the blog post that will appear on the main listing 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 blog post 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. |
publishedAt | string | Required within parent | The date and time when the blog post was published, in ISO 8601 format. Format: date-time |
rssBody | string | Required within parent | The contents of the RSS body for this Blog Post. |
rssSummary | string | Required within parent | The contents of the RSS summary for this Blog Post. |
slug | string | Required within parent | The path of the this blog post. This field is appended to the domain to construct the url of this post. |
state | string | Required within parent | An ENUM descibing the current state of this Blog Post. Maximum length: 25 |
tagIds | array | Required within parent | List of IDs for the tags associated with this Blog Post. |
tagIds[] | integer | Each item | Format: int64 |
themeSettingsValues | object | Required within parent | A collection of settings specific to the theme applied to the blog post. Additional keys: see wildcard field |
themeSettingsValues.* | object | Additional keys | |
translatedFromId | string | Required within parent | ID of the primary blog post this object was translated from. |
translations | object | Required within parent | A map of translations for the blog post, each associated with a specific language variation. Additional keys: see wildcard field |
translations.* | Model | Additional keys | Expand Update a post — request body — body translations value |
updated | string | Required within parent | The timestamp (ISO8601 format) when this Blog Post was updated. Format: date-time |
updatedById | string | Required within parent | The ID of the user that updated this Blog Post. |
url | string | Required within parent | A generated field representing the URL of this blog post. |
useFeaturedImage | boolean | Required within parent | Boolean to determine if this post should use a featuredImage. |
widgetContainers | object | Required within parent | A data structure containing the data for all the modules inside the containers for this post. 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: Update a post — request body — body translations value, Update a post — request body — body layout Sections value, List tags — response body
Detach post from a multi-language group — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | ID of the object to remove from a multi-language group. |
Get all posts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Get all posts — response body — paging |
results | array | Required within parent | Collection of blog posts. |
results[] | Model | Each item | Expand Update a post — response body |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Total number of blog posts. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get all posts — response body — paging, Update a post — response body
Get all posts — 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 posts — response body — paging next |
Referenced models: Get all posts — response body — paging next
Get all posts — 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 token representing the paging cursor of the last successfully read resource. This token is used to fetch the next set of results in a paged response. |
link | string | Optional | A string URL that provides the link to the next page of results in a paged response. |
List tags — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
after | string | Optional | |
archived | boolean | Optional | |
createdAfter | string | Optional | Format: date-time |
createdAt | string | Optional | Format: date-time |
createdBefore | string | Optional | Format: date-time |
limit | integer | Optional | Format: int32 |
property | string | Optional | |
sort | array | Optional | |
sort[] | string | Each item | |
updatedAfter | string | Optional | Format: date-time |
updatedAt | string | Optional | Format: date-time |
updatedBefore | string | Optional | Format: date-time |
List tags — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root |
Retrieve a previous version of a blog post — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier for this specific version of the blog post. |
object | Model | Required within parent | Expand Update a post — response body |
updatedAt | string | Required within parent | The date and time when this version of the blog post was last updated, in ISO 8601 format. Format: date-time |
user | Model | Required within parent | Expand Get a specific blog revision — response body — user |
Referenced models: Get a specific blog revision — response body — user, Update a post — response body
Retrieves all previous versions of a post — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Retrieves all previous versions of a post — response body — paging |
results | array | Required within parent | An array containing the individual blog post versions. Each item in the array represents a specific version of a blog post. |
results[] | Model | Each item | Expand Retrieves all previous versions of a post — response body — results item |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | The total number of blog post versions available. This is an integer value. Format: int32 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieves all previous versions of a post — response body — paging, Retrieves all previous versions of a post — response body — results item
Retrieves all previous versions of a post — 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 posts — response body — paging next |
prev | Model | Optional | Expand Retrieves all previous versions of a post — response body — paging prev |
Referenced models: Get all posts — response body — paging next, Retrieves all previous versions of a post — response body — paging prev
Retrieves all previous versions of a post — 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 that represents the cursor for the previous page of results. |
link | string | Optional | A URL string that provides the link to access the previous page of results. |
Retrieves all previous versions of a post — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The id of the version. |
object | Model | Required within parent | Expand Update a post — response body |
updatedAt | string | Required within parent | The timestamp (ISO8601 format) when this version of the Blog Post was updated. Format: date-time |
user | Model | Required within parent | Expand Get a specific blog revision — response body — user |
Referenced models: Get a specific blog revision — response body — user, Update a post — response body
Schedule a post to be published — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The ID of the object to be scheduled. |
publishDate | string | Required within parent | The date the object should transition from scheduled to published. Format: date-time |
Update a post — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
abStatus | string | Optional | The status of the AB test associated with this blog post, if applicable Available options: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant 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 | integer | Optional | The timestamp (ISO8601 format) when this Blog Post was deleted. Format: int64 |
archivedInDashboard | boolean | Optional | If True, the post will not show up in your dashboard, although the post could still be live. |
attachedStylesheets | array | Optional | List of stylesheets to attach to this blog post. 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 Blog Post. |
blogAuthorId | string | Optional | The ID of the Blog Author associated with this Blog Post. |
campaign | string | Optional | The GUID of the marketing campaign this Blog Post is a part of. |
categoryId | integer | Optional | ID of the type of object this is. Should always . Format: int32 |
contentGroupId | string | Optional | The ID of the parent Blog this Blog Post is associated with. |
contentTypeCategory | string | Optional | An ENUM descibing the type of this object. Should always be BLOG_POST. 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 (ISO8601 format) when this Blog Post was created. Format: date-time |
createdById | string | Optional | The ID of the user that created this Blog Post. |
currentState | string | Optional | A generated ENUM descibing the current state of this Blog Post. Should always match state. One of: AGENT_GENERATED, AUTOMATED, AUTOMATED_AB, AUTOMATED_AB_VARIANT, AUTOMATED_DRAFT, AUTOMATED_DRAFT_AB, AUTOMATED_DRAFT_ABVARIANT, AUTOMATED_FOR_FORM, AUTOMATED_FOR_FORM_BUFFER, AUTOMATED_FOR_FORM_DRAFT, AUTOMATED_FOR_FORM_LEGACY, AUTOMATED_LOSER_ABVARIANT, AUTOMATED_SENDING, BLOG_EMAIL_DRAFT, BLOG_EMAIL_PUBLISHED, DRAFT, DRAFT_AB, DRAFT_AB_VARIANT, ERROR, LOSER_AB_VARIANT, PAGE_STUB, PRE_PROCESSING, PROCESSING, PUBLISHED, PUBLISHED_AB, PUBLISHED_AB_VARIANT, PUBLISHED_OR_SCHEDULED, RSS_TO_EMAIL_DRAFT, RSS_TO_EMAIL_PUBLISHED, SCHEDULED, SCHEDULED_AB, SCHEDULED_OR_PUBLISHED |
currentlyPublished | boolean | Optional | Whether the post is published (true or false) |
domain | string | Optional | The domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog. |
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 Blog Post references, if applicable |
enableDomainStylesheets | boolean | Optional | Boolean to determine whether or not the styles from the template should be applied. |
enableGoogleAmpOutputOverride | boolean | Optional | Boolean to allow overriding the AMP settings for the blog. |
enableLayoutStylesheets | boolean | Optional | Boolean to determine whether or not the styles from the template should be applied. |
featuredImage | string | Optional | The featuredImage of this Blog Post. |
featuredImageAltText | string | Optional | Alt Text of the featuredImage. |
folderId | string | Optional | Unique identifier of associated folder |
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 Blog Post. |
id | string | Optional | The unique ID of the Blog Post. |
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 Blog Post. If null, the Blog Post will default to the language of the ParentBlog. 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 blog post. Additional keys: see wildcard field |
layoutSections.* | Model | Additional keys | Expand Update a post — 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 | Unique identifier of the MAB Experiment |
metaDescription | string | Optional | A description that goes in <meta> tag on the page. |
name | string | Optional | The internal name of the Blog Post. |
pageExpiryDate | integer | Optional | The date at which this blog post 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 blog post. |
pageExpiryRedirectId | integer | Optional | The ID of another page this blog post's url should redirect to once this blog post expires. Should only set this or pageExpiryRedirectUrl. Format: int64 |
pageExpiryRedirectUrl | string | Optional | The URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId. |
password | string | Optional | Set this to create a password protected page. Entering the password will be required to view the page. |
postBody | string | Optional | The HTML of the main post body. |
postSummary | string | Optional | The summary of the blog post that will appear on the main listing 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 blog post 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. |
publishedAt | string | Optional | The date and time when the blog post was published, in ISO 8601 format. Format: date-time |
rssBody | string | Optional | The contents of the RSS body for this Blog Post. |
rssSummary | string | Optional | The contents of the RSS summary for this Blog Post. |
slug | string | Optional | The path of the this blog post. This field is appended to the domain to construct the url of this post. |
state | string | Optional | An ENUM descibing the current state of this Blog Post. Maximum length: 25 |
tagIds | array | Optional | List of IDs for the tags associated with this Blog Post. |
tagIds[] | integer | Each item | Format: int64 |
themeSettingsValues | object | Optional | A collection of settings specific to the theme applied to the blog post. Additional keys: see wildcard field |
themeSettingsValues.* | object | Additional keys | |
translatedFromId | string | Optional | ID of the primary blog post this object was translated from. |
translations | object | Optional | A map of translations for the blog post, each associated with a specific language variation. Additional keys: see wildcard field |
translations.* | Model | Additional keys | Expand Update a post — request body — body translations value |
updated | string | Optional | The timestamp (ISO8601 format) when this Blog Post was updated. Format: date-time |
updatedById | string | Optional | The ID of the user that updated this Blog Post. |
url | string | Optional | A generated field representing the URL of this blog post. |
useFeaturedImage | boolean | Optional | Boolean to determine if this post should use a featuredImage. |
widgetContainers | object | Optional | A data structure containing the data for all the modules inside the containers for this post. 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: Update a post — request body — body translations value, Update a post — request body — body layout Sections value, List tags — response body
Update a post — request body — body layout Sections value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells | array | Required within parent | The cells contained within the layout section, defining its structure. |
cells[] | Model | Each item | Expand Update a post — 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 name assigned to the layout section. |
params | object | Required within parent | Additional parameters for the layout section, typically used for configuration. Additional keys: see wildcard field |
params.* | object | Additional keys | |
rowMetaData | array | Required within parent | Metadata associated with the rows in the layout section. |
rowMetaData[] | Model | Each item | Expand Update a post — request body — body layout Sections value row Meta Data item |
rows | array | Required within parent | The number of rows in the layout section. |
rows[] | object | Each item | Additional keys: see wildcard field |
rows[].* | Model | Additional keys | Expand Update a post — request body — body layout Sections value |
styles | Model | Required within parent | Expand Update a post — 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: Update a post — request body — body layout Sections value, Update a post — request body — body layout Sections value row Meta Data item, Update a post — request body — body layout Sections value styles
Update a post — 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. |
styles | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles |
Referenced models: Update a post — request body — body layout Sections value styles
Update a post — 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 Update a post — 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 | Breakpoint CSS styles for margin, padding, etc... Additional keys: see wildcard field |
breakpointStyles.* | Model | Additional keys | Expand Update a post — 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, Update a post — request body — body layout Sections value styles breakpoint Styles value, Update a post — request body — body layout Sections value styles background Gradient, Update a post — request body — body layout Sections value styles background Color
Update a post — request body — body layout Sections value styles background Color
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
a | number | Required within parent | Alpha. |
b | integer | Required within parent | Blue. Format: int32 |
g | integer | Required within parent | Green. Format: int32 |
r | integer | Required within parent | Red. Format: int32 |
Update a post — 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 colors used in the gradient. Each color is represented as an RGBA value, defining the color stops in 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
Update a post — request body — body layout Sections value styles background Gradient angle
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
units | string | Required within parent | The unit of measurement for the angle. One of: DEGREES, GRADIANS, RADIANS, TURNS |
value | number | Required within parent | The numerical representation of the angle. |
Update a post — request body — body layout Sections value styles background Gradient colors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles background Color |
Referenced models: Update a post — request body — body layout Sections value styles background Color
Update a post — request body — body layout Sections value styles background Gradient side Or Corner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
horizontalSide | string | Required within parent | Specifies the horizontal side of an element. One of: CENTER, LEFT, RIGHT |
verticalSide | string | Required within parent | Specifies the vertical side of an element. One of: BOTTOM, MIDDLE, TOP |
Update a post — request body — body layout Sections value styles breakpoint Styles value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hidden | boolean | Required within parent | Boolean indicating if the breakpoint is visible. |
margin | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles breakpoint Styles value margin |
padding | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles breakpoint Styles value padding |
Referenced models: Update a post — request body — body layout Sections value styles breakpoint Styles value margin, Update a post — request body — body layout Sections value styles breakpoint Styles value padding
Update a post — 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 Update a post — request body — body layout Sections value styles breakpoint Styles value margin top |
top | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles breakpoint Styles value margin top |
Referenced models: Update a post — request body — body layout Sections value styles breakpoint Styles value margin top
Update a post — 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. Valid values include 'CM', 'MM', 'Q', 'IN', 'PC', 'PT', 'PX', 'EM', 'EX', 'CH', 'REM', 'LH', 'VW', 'VH', 'VMIN', 'VMAX', and 'PERCENTAGE'. 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 numeric value representing the magnitude of the size. |
Update a post — 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 Update a post — request body — body layout Sections value styles breakpoint Styles value margin top |
left | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles breakpoint Styles value margin top |
right | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles breakpoint Styles value margin top |
top | Model | Required within parent | Expand Update a post — request body — body layout Sections value styles breakpoint Styles value margin top |
Referenced models: Update a post — request body — body layout Sections value styles breakpoint Styles value margin top
Update a post — request body — body translations value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archivedInDashboard | boolean | Required within parent | If True, the variant will not show up in your dashboard, although the post could still be live. |
authorName | string | Required within parent | The name of the user who last published the blog post. For posts that haven't been published yet, this property will reflect the user who initially created the draft. |
campaign | string | Required within parent | The GUID of the marketing campaign this page is a part of. |
campaignName | string | Required within parent | Name of the associated marketing campaign. |
created | string | Required within parent | The timestamp (ISO8601 format) when this Blog Post 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 content language variation. |
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 | The set of rules governing public access to this language variation. |
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 |
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 describing the current state of this page. Maximum string length: 25 |
tagIds | array | Optional | An array of tag identifiers associated with this language variation. |
tagIds[] | integer | Each item | Format: int64 |
updated | string | Required within parent | The timestamp (ISO8601 format) when this Blog Post was updated. Format: date-time |
Referenced models: List tags — response body
Update a post — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
abStatus | string | Required within parent | The status of the AB test associated with this blog post, if applicable Available options: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant 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 | JSON | Required within parent | |
archivedAt (anyOf 1) | integer | Alternative | The timestamp (ISO8601 format) when this Blog Post was deleted. Format: int64 |
archivedAt (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
archivedInDashboard | boolean | Required within parent | If True, the post will not show up in your dashboard, although the post could still be live. |
attachedStylesheets | array | Required within parent | List of stylesheets to attach to this blog post. 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 Blog Post. |
blogAuthorId | string | Required within parent | The ID of the Blog Author associated with this Blog Post. |
campaign | string | Required within parent | The GUID of the marketing campaign this Blog Post 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 | The ID of the parent Blog this Blog Post is associated with. |
contentTypeCategory | string | Required within parent | An ENUM descibing the type of this object. Should always be BLOG_POST. 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 (ISO8601 format) when this Blog Post was created. Format: date-time |
createdById | string | Required within parent | The ID of the user that created this Blog Post. |
currentState | string | Required within parent | A generated ENUM descibing the current state of this Blog Post. Should always match state. Known values: AGENT_GENERATED, AUTOMATED, AUTOMATED_AB, AUTOMATED_AB_VARIANT, AUTOMATED_DRAFT, AUTOMATED_DRAFT_AB, AUTOMATED_DRAFT_ABVARIANT, AUTOMATED_FOR_FORM, AUTOMATED_FOR_FORM_BUFFER, AUTOMATED_FOR_FORM_DRAFT, AUTOMATED_FOR_FORM_LEGACY, AUTOMATED_LOSER_ABVARIANT, AUTOMATED_SENDING, BLOG_EMAIL_DRAFT, BLOG_EMAIL_PUBLISHED, DRAFT, DRAFT_AB, DRAFT_AB_VARIANT, ERROR, LOSER_AB_VARIANT, PAGE_STUB, PRE_PROCESSING, PROCESSING, PUBLISHED, PUBLISHED_AB, PUBLISHED_AB_VARIANT, PUBLISHED_OR_SCHEDULED, RSS_TO_EMAIL_DRAFT, RSS_TO_EMAIL_PUBLISHED, SCHEDULED, SCHEDULED_AB, SCHEDULED_OR_PUBLISHED |
currentlyPublished | boolean | Required within parent | Whether the post is published (true or false) |
domain | string | Required within parent | The domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog. |
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 Blog Post references, if applicable |
enableDomainStylesheets | boolean | Required within parent | Boolean to determine whether or not the styles from the template should be applied. |
enableGoogleAmpOutputOverride | boolean | Required within parent | Boolean to allow overriding the AMP settings for the blog. |
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 Blog Post. |
featuredImageAltText | string | Required within parent | Alt Text of the featuredImage. |
folderId | string | Required within parent | Unique identifier of associated folder |
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 Blog Post. |
id | string | Required within parent | The unique ID of the Blog Post. |
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 Blog Post. If null, the Blog Post will default to the language of the ParentBlog. 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 blog post. Additional keys: see wildcard field |
layoutSections.* | Model | Additional keys | Expand Update a post — 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 | Unique identifier of the MAB Experiment |
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 Blog Post. |
pageExpiryDate | JSON | Required within parent | |
pageExpiryDate (anyOf 1) | integer | Alternative | The date at which this blog post 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 blog post. |
pageExpiryRedirectId | JSON | Required within parent | |
pageExpiryRedirectId (anyOf 1) | integer | Alternative | The ID of another page this blog post's url should redirect to once this blog post 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 blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId. |
password | string | Required within parent | Set this to create a password protected page. Entering the password will be required to view the page. |
postBody | string | Required within parent | The HTML of the main post body. |
postSummary | string | Required within parent | The summary of the blog post that will appear on the main listing 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 blog post 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. |
publishedAt | string | Required within parent | The date and time when the blog post was published, in ISO 8601 format. Format: date-time |
rssBody | string | Required within parent | The contents of the RSS body for this Blog Post. |
rssSummary | string | Required within parent | The contents of the RSS summary for this Blog Post. |
slug | string | Required within parent | The path of the this blog post. This field is appended to the domain to construct the url of this post. |
state | string | Required within parent | An ENUM descibing the current state of this Blog Post. Maximum length: 25 |
tagIds | array | Required within parent | List of IDs for the tags associated with this Blog Post. |
tagIds[] | JSON | Each item | |
tagIds[] (anyOf 1) | integer | Alternative | Format: int64 |
tagIds[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
themeSettingsValues | object | Required within parent | A collection of settings specific to the theme applied to the blog post. Additional keys: see wildcard field |
themeSettingsValues.* | object | Additional keys | |
translatedFromId | string | Required within parent | ID of the primary blog post this object was translated from. |
translations | object | Required within parent | A map of translations for the blog post, each associated with a specific language variation. Additional keys: see wildcard field |
translations.* | Model | Additional keys | Expand Update a post — response body — translations value |
updated | string | Required within parent | The timestamp (ISO8601 format) when this Blog Post was updated. Format: date-time |
updatedById | string | Required within parent | The ID of the user that updated this Blog Post. |
url | string | Required within parent | A generated field representing the URL of this blog post. |
useFeaturedImage | boolean | Required within parent | Boolean to determine if this post should use a featuredImage. |
widgetContainers | object | Required within parent | A data structure containing the data for all the modules inside the containers for this post. 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, Update a post — response body — translations value, Update a post — response body — layout Sections value
Update a post — response body — layout Sections value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells | array | Required within parent | The cells contained within the layout section, defining its structure. |
cells[] | Model | Each item | Expand Update a post — 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 name assigned to the layout section. |
params | object | Required within parent | Additional parameters for the layout section, typically used for configuration. Additional keys: see wildcard field |
params.* | object | Additional keys | |
rowMetaData | array | Required within parent | Metadata associated with the rows in the layout section. |
rowMetaData[] | Model | Each item | Expand Update a post — response body — layout Sections value row Meta Data item |
rows | array | Required within parent | The number of rows in the layout section. |
rows[] | object | Each item | Additional keys: see wildcard field |
rows[].* | Model | Additional keys | Expand Update a post — response body — layout Sections value |
styles | Model | Required within parent | Expand Update a post — 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: Update a post — response body — layout Sections value, Update a post — response body — layout Sections value row Meta Data item, Update a post — response body — layout Sections value styles
Update a post — 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. |
styles | Model | Required within parent | Expand Update a post — response body — layout Sections value styles |
Referenced models: Update a post — response body — layout Sections value styles
Update a post — 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 Update a post — 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 | Breakpoint CSS styles for margin, padding, etc... Additional keys: see wildcard field |
breakpointStyles.* | Model | Additional keys | Expand Update a post — 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, Update a post — response body — layout Sections value styles breakpoint Styles value, Update a post — response body — layout Sections value styles background Gradient, Update a post — response body — layout Sections value styles background Color
Update a post — response body — layout Sections value styles background Color
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
a | JSON | Required within parent | |
a (anyOf 1) | number | Alternative | Alpha. |
a (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
b | JSON | Required within parent | |
b (anyOf 1) | integer | Alternative | Blue. Format: int32 |
b (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
g | JSON | Required within parent | |
g (anyOf 1) | integer | Alternative | Green. Format: int32 |
g (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
r | JSON | Required within parent | |
r (anyOf 1) | integer | Alternative | Red. Format: int32 |
r (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a post — 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 colors used in the gradient. Each color is represented as an RGBA value, defining the color stops in 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
Update a post — response body — layout Sections value styles background Gradient angle
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
units | string | Required within parent | The unit of measurement for the angle. Known values: DEGREES, GRADIANS, RADIANS, TURNS |
value | JSON | Required within parent | |
value (anyOf 1) | number | Alternative | The numerical representation of the angle. |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a post — response body — layout Sections value styles background Gradient colors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | Model | Required within parent | Expand Update a post — response body — layout Sections value styles background Color |
Referenced models: Update a post — response body — layout Sections value styles background Color
Update a post — response body — layout Sections value styles background Gradient side Or Corner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
horizontalSide | string | Required within parent | Specifies the horizontal side of an element. Known values: CENTER, LEFT, RIGHT |
verticalSide | string | Required within parent | Specifies the vertical side of an element. Known values: BOTTOM, MIDDLE, TOP |
Update a post — response body — layout Sections value styles background Image
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
backgroundPosition | string | Required within parent | Defines the position of the background image. |
backgroundSize | string | Required within parent | Specifies the size of the background image. |
imageUrl | string | Required within parent | The URL of the background image. |
Update a post — response body — layout Sections value styles breakpoint Styles value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hidden | boolean | Required within parent | Boolean indicating if the breakpoint is visible. |
margin | Model | Required within parent | Expand Update a post — response body — layout Sections value styles breakpoint Styles value margin |
padding | Model | Required within parent | Expand Update a post — response body — layout Sections value styles breakpoint Styles value padding |
Referenced models: Update a post — response body — layout Sections value styles breakpoint Styles value margin, Update a post — response body — layout Sections value styles breakpoint Styles value padding
Update a post — response body — layout Sections value styles breakpoint Styles value margin
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bottom | Model | Required within parent | Expand Update a post — response body — layout Sections value styles breakpoint Styles value margin top |
top | Model | Required within parent | Expand Update a post — response body — layout Sections value styles breakpoint Styles value margin top |
Referenced models: Update a post — response body — layout Sections value styles breakpoint Styles value margin top
Update a post — 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. Valid values include 'CM', 'MM', 'Q', 'IN', 'PC', 'PT', 'PX', 'EM', 'EX', 'CH', 'REM', 'LH', 'VW', 'VH', 'VMIN', 'VMAX', and 'PERCENTAGE'. 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 numeric value representing the magnitude of the size. |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a post — response body — layout Sections value styles breakpoint Styles value padding
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bottom | Model | Required within parent | Expand Update a post — response body — layout Sections value styles breakpoint Styles value margin top |
left | Model | Required within parent | Expand Update a post — response body — layout Sections value styles breakpoint Styles value margin top |
right | Model | Required within parent | Expand Update a post — response body — layout Sections value styles breakpoint Styles value margin top |
top | Model | Required within parent | Expand Update a post — response body — layout Sections value styles breakpoint Styles value margin top |
Referenced models: Update a post — response body — layout Sections value styles breakpoint Styles value margin top
Update a post — response body — translations value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archivedInDashboard | boolean | Required within parent | If True, the variant will not show up in your dashboard, although the post could still be live. |
authorName | string | Required within parent | The name of the user who last published the blog post. For posts that haven't been published yet, this property will reflect the user who initially created the draft. |
campaign | string | Required within parent | The GUID of the marketing campaign this page is a part of. |
campaignName | string | Required within parent | Name of the associated marketing campaign. |
created | string | Required within parent | The timestamp (ISO8601 format) when this Blog Post 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 content language variation. |
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 | The set of rules governing public access to this language variation. |
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 |
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 describing the current state of this page. Maximum string length: 25 |
tagIds | array | Optional | An array of tag identifiers 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 timestamp (ISO8601 format) when this Blog Post was updated. Format: date-time |
Referenced models: List tags — response body