Skip to content

HubSpot: Blog posts schemas

47 HubSpot schemas with complete fields and constraints.

← Blog posts operations · All schemas

Clone a blog post — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
cloneNamestringOptionalName of the cloned object.
idstringRequired within parentID of the object to be cloned.

Create a batch of blog posts — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
inputsarrayRequired within parentBlog posts to input.
inputs[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
completedAtstringRequired within parentTime of batch operation completion.
Format: date-time
linksobjectOptionalLinks associated with batch operation.
Additional keys: see wildcard field
links.*stringAdditional keys
requestedAtstringOptionalTime of batch operation request.
Format: date-time
resultsarrayRequired within parentResults of batch operation.
results[]ModelEach itemExpand Update a post — response body
startedAtstringRequired within parentTime of batch operation start.
Format: date-time
statusstringRequired within parentStatus 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

FieldTypePresenceDescription and constraints
$objectRoot
completedAtstringRequired within parentTime of batch operation completion.
Format: date-time
errorsarrayOptionalErrors in batch operation.
errors[]ModelEach itemExpand Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
linksobjectOptionalLinks associated with batch operation.
Additional keys: see wildcard field
links.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeNumber of errors.
Format: int32
numErrors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAtstringOptionalTime of batch operation request.
Format: date-time
resultsarrayRequired within parentResults of batch operation.
results[]ModelEach itemExpand Update a post — response body
startedAtstringRequired within parentTime of batch operation start.
Format: date-time
statusstringRequired within parentStatus 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentID of blog post to clone.
languagestringOptionalTarget language of new variant.
usePublishedbooleanOptionalA 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

FieldTypePresenceDescription and constraints
$objectRoot
abStatusstringRequired within parentThe 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
abTestIdstringRequired within parentThe ID of the AB test associated with this page, if applicable
archivedAtintegerRequired within parentThe timestamp (ISO8601 format) when this Blog Post was deleted.
Format: int64
archivedInDashboardbooleanRequired within parentIf True, the post will not show up in your dashboard, although the post could still be live.
attachedStylesheetsarrayRequired within parentList 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[]objectEach itemAdditional keys: see wildcard field
attachedStylesheets[].*objectAdditional keys
authorNamestringRequired within parentThe name of the user that updated this Blog Post.
blogAuthorIdstringRequired within parentThe ID of the Blog Author associated with this Blog Post.
campaignstringRequired within parentThe GUID of the marketing campaign this Blog Post is a part of.
categoryIdintegerRequired within parentID of the type of object this is. Should always .
Format: int32
contentGroupIdstringRequired within parentThe ID of the parent Blog this Blog Post is associated with.
contentTypeCategorystringRequired within parentAn 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
createdstringRequired within parentThe timestamp (ISO8601 format) when this Blog Post was created.
Format: date-time
createdByIdstringRequired within parentThe ID of the user that created this Blog Post.
currentStatestringRequired within parentA 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
currentlyPublishedbooleanRequired within parentWhether the post is published (true or false)
domainstringRequired within parentThe domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog.
dynamicPageDataSourceIdstringRequired within parentThe identifier for the data source used by the dynamic page.
dynamicPageDataSourceTypeintegerRequired within parentThe type of data source used by the dynamic page.
Format: int32
dynamicPageHubDbTableIdstringRequired within parentThe ID of the HubDB table this Blog Post references, if applicable
enableDomainStylesheetsbooleanRequired within parentBoolean to determine whether or not the styles from the template should be applied.
enableGoogleAmpOutputOverridebooleanRequired within parentBoolean to allow overriding the AMP settings for the blog.
enableLayoutStylesheetsbooleanRequired within parentBoolean to determine whether or not the styles from the template should be applied.
featuredImagestringRequired within parentThe featuredImage of this Blog Post.
featuredImageAltTextstringRequired within parentAlt Text of the featuredImage.
folderIdstringRequired within parentUnique identifier of associated folder
footerHtmlstringRequired within parentCustom HTML for embed codes, javascript that should be placed before the </body> tag of the page.
headHtmlstringRequired within parentCustom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page.
htmlTitlestringRequired within parentThe html title of this Blog Post.
idstringRequired within parentThe unique ID of the Blog Post.
includeDefaultCustomCssbooleanRequired within parentBoolean to determine whether or not the Primary CSS Files should be applied.
languagestringRequired within parentThe 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
layoutSectionsobjectRequired within parentA structure detailing the layout sections of the blog post.
Additional keys: see wildcard field
layoutSections.*ModelAdditional keysExpand Update a post — request body — body layout Sections value
linkRelCanonicalUrlstringRequired within parentOptional override to set the URL to be used in the rel=canonical link tag on the page.
mabExperimentIdstringRequired within parentUnique identifier of the MAB Experiment
metaDescriptionstringRequired within parentA description that goes in <meta> tag on the page.
namestringRequired within parentThe internal name of the Blog Post.
pageExpiryDateintegerRequired within parentThe date at which this blog post should expire and begin redirecting to another url or page.
Format: int64
pageExpiryEnabledbooleanRequired within parentBoolean describing if the page expiration feature is enabled for this blog post.
pageExpiryRedirectIdintegerRequired within parentThe 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
pageExpiryRedirectUrlstringRequired within parentThe URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId.
passwordstringRequired within parentSet this to create a password protected page. Entering the password will be required to view the page.
postBodystringRequired within parentThe HTML of the main post body.
postSummarystringRequired within parentThe summary of the blog post that will appear on the main listing page.
publicAccessRulesarrayRequired within parentRules for require member registration to access private content.
publicAccessRules[]ModelEach itemExpand List tags — response body
publicAccessRulesEnabledbooleanRequired within parentBoolean to determine whether or not to respect publicAccessRules.
publishDatestringRequired within parentThe date (ISO8601 format) the blog post is to be published at.
Format: date-time
publishImmediatelybooleanRequired within parentSet this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.
publishedAtstringRequired within parentThe date and time when the blog post was published, in ISO 8601 format.
Format: date-time
rssBodystringRequired within parentThe contents of the RSS body for this Blog Post.
rssSummarystringRequired within parentThe contents of the RSS summary for this Blog Post.
slugstringRequired within parentThe path of the this blog post. This field is appended to the domain to construct the url of this post.
statestringRequired within parentAn ENUM descibing the current state of this Blog Post.
Maximum length: 25
tagIdsarrayRequired within parentList of IDs for the tags associated with this Blog Post.
tagIds[]integerEach itemFormat: int64
themeSettingsValuesobjectRequired within parentA collection of settings specific to the theme applied to the blog post.
Additional keys: see wildcard field
themeSettingsValues.*objectAdditional keys
translatedFromIdstringRequired within parentID of the primary blog post this object was translated from.
translationsobjectRequired within parentA map of translations for the blog post, each associated with a specific language variation.
Additional keys: see wildcard field
translations.*ModelAdditional keysExpand Update a post — request body — body translations value
updatedstringRequired within parentThe timestamp (ISO8601 format) when this Blog Post was updated.
Format: date-time
updatedByIdstringRequired within parentThe ID of the user that updated this Blog Post.
urlstringRequired within parentA generated field representing the URL of this blog post.
useFeaturedImagebooleanRequired within parentBoolean to determine if this post should use a featuredImage.
widgetContainersobjectRequired within parentA 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.*objectAdditional keys
widgetsobjectRequired within parentA data structure containing the data for all the modules for this page.
Additional keys: see wildcard field
widgets.*objectAdditional 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentID of the object to remove from a multi-language group.

Get all posts — response body

FieldTypePresenceDescription and constraints
$objectRoot
pagingModelOptionalExpand Get all posts — response body — paging
resultsarrayRequired within parentCollection of blog posts.
results[]ModelEach itemExpand Update a post — response body
totalJSONRequired within parent
total (anyOf 1)integerAlternativeTotal number of blog posts.
Format: int32
total (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRootPaging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
nextModelOptionalExpand Get all posts — response body — paging next

Referenced models: Get all posts — response body — paging next

Get all posts — response body — paging next

FieldTypePresenceDescription and constraints
$objectRootSpecifies the paging information needed to retrieve the next set of results in a paginated API response
afterstringRequired within parentA 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.
linkstringOptionalA string URL that provides the link to the next page of results in a paged response.

List tags — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
afterstringOptional
archivedbooleanOptional
createdAfterstringOptionalFormat: date-time
createdAtstringOptionalFormat: date-time
createdBeforestringOptionalFormat: date-time
limitintegerOptionalFormat: int32
propertystringOptional
sortarrayOptional
sort[]stringEach item
updatedAfterstringOptionalFormat: date-time
updatedAtstringOptionalFormat: date-time
updatedBeforestringOptionalFormat: date-time

List tags — response body

FieldTypePresenceDescription and constraints
$objectRoot

Retrieve a previous version of a blog post — response body

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier for this specific version of the blog post.
objectModelRequired within parentExpand Update a post — response body
updatedAtstringRequired within parentThe date and time when this version of the blog post was last updated, in ISO 8601 format.
Format: date-time
userModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
pagingModelOptionalExpand Retrieves all previous versions of a post — response body — paging
resultsarrayRequired within parentAn array containing the individual blog post versions. Each item in the array represents a specific version of a blog post.
results[]ModelEach itemExpand Retrieves all previous versions of a post — response body — results item
totalJSONRequired within parent
total (anyOf 1)integerAlternativeThe total number of blog post versions available. This is an integer value.
Format: int32
total (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
nextModelOptionalExpand Get all posts — response body — paging next
prevModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootspecifies the paging information needed to retrieve the previous set of results in a paginated API response
beforestringRequired within parentA string token that represents the cursor for the previous page of results.
linkstringOptionalA URL string that provides the link to access the previous page of results.

Retrieves all previous versions of a post — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe id of the version.
objectModelRequired within parentExpand Update a post — response body
updatedAtstringRequired within parentThe timestamp (ISO8601 format) when this version of the Blog Post was updated.
Format: date-time
userModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe ID of the object to be scheduled.
publishDatestringRequired within parentThe date the object should transition from scheduled to published.
Format: date-time

Update a post — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
abStatusstringOptionalThe 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
abTestIdstringOptionalThe ID of the AB test associated with this page, if applicable
archivedAtintegerOptionalThe timestamp (ISO8601 format) when this Blog Post was deleted.
Format: int64
archivedInDashboardbooleanOptionalIf True, the post will not show up in your dashboard, although the post could still be live.
attachedStylesheetsarrayOptionalList 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[]objectEach itemAdditional keys: see wildcard field
attachedStylesheets[].*objectAdditional keys
authorNamestringOptionalThe name of the user that updated this Blog Post.
blogAuthorIdstringOptionalThe ID of the Blog Author associated with this Blog Post.
campaignstringOptionalThe GUID of the marketing campaign this Blog Post is a part of.
categoryIdintegerOptionalID of the type of object this is. Should always .
Format: int32
contentGroupIdstringOptionalThe ID of the parent Blog this Blog Post is associated with.
contentTypeCategorystringOptionalAn 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
createdstringOptionalThe timestamp (ISO8601 format) when this Blog Post was created.
Format: date-time
createdByIdstringOptionalThe ID of the user that created this Blog Post.
currentStatestringOptionalA 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
currentlyPublishedbooleanOptionalWhether the post is published (true or false)
domainstringOptionalThe domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog.
dynamicPageDataSourceIdstringOptionalThe identifier for the data source used by the dynamic page.
dynamicPageDataSourceTypeintegerOptionalThe type of data source used by the dynamic page.
Format: int32
dynamicPageHubDbTableIdstringOptionalThe ID of the HubDB table this Blog Post references, if applicable
enableDomainStylesheetsbooleanOptionalBoolean to determine whether or not the styles from the template should be applied.
enableGoogleAmpOutputOverridebooleanOptionalBoolean to allow overriding the AMP settings for the blog.
enableLayoutStylesheetsbooleanOptionalBoolean to determine whether or not the styles from the template should be applied.
featuredImagestringOptionalThe featuredImage of this Blog Post.
featuredImageAltTextstringOptionalAlt Text of the featuredImage.
folderIdstringOptionalUnique identifier of associated folder
footerHtmlstringOptionalCustom HTML for embed codes, javascript that should be placed before the </body> tag of the page.
headHtmlstringOptionalCustom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page.
htmlTitlestringOptionalThe html title of this Blog Post.
idstringOptionalThe unique ID of the Blog Post.
includeDefaultCustomCssbooleanOptionalBoolean to determine whether or not the Primary CSS Files should be applied.
languagestringOptionalThe 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
layoutSectionsobjectOptionalA structure detailing the layout sections of the blog post.
Additional keys: see wildcard field
layoutSections.*ModelAdditional keysExpand Update a post — request body — body layout Sections value
linkRelCanonicalUrlstringOptionalOptional override to set the URL to be used in the rel=canonical link tag on the page.
mabExperimentIdstringOptionalUnique identifier of the MAB Experiment
metaDescriptionstringOptionalA description that goes in <meta> tag on the page.
namestringOptionalThe internal name of the Blog Post.
pageExpiryDateintegerOptionalThe date at which this blog post should expire and begin redirecting to another url or page.
Format: int64
pageExpiryEnabledbooleanOptionalBoolean describing if the page expiration feature is enabled for this blog post.
pageExpiryRedirectIdintegerOptionalThe 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
pageExpiryRedirectUrlstringOptionalThe URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId.
passwordstringOptionalSet this to create a password protected page. Entering the password will be required to view the page.
postBodystringOptionalThe HTML of the main post body.
postSummarystringOptionalThe summary of the blog post that will appear on the main listing page.
publicAccessRulesarrayOptionalRules for require member registration to access private content.
publicAccessRules[]ModelEach itemExpand List tags — response body
publicAccessRulesEnabledbooleanOptionalBoolean to determine whether or not to respect publicAccessRules.
publishDatestringOptionalThe date (ISO8601 format) the blog post is to be published at.
Format: date-time
publishImmediatelybooleanOptionalSet this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.
publishedAtstringOptionalThe date and time when the blog post was published, in ISO 8601 format.
Format: date-time
rssBodystringOptionalThe contents of the RSS body for this Blog Post.
rssSummarystringOptionalThe contents of the RSS summary for this Blog Post.
slugstringOptionalThe path of the this blog post. This field is appended to the domain to construct the url of this post.
statestringOptionalAn ENUM descibing the current state of this Blog Post.
Maximum length: 25
tagIdsarrayOptionalList of IDs for the tags associated with this Blog Post.
tagIds[]integerEach itemFormat: int64
themeSettingsValuesobjectOptionalA collection of settings specific to the theme applied to the blog post.
Additional keys: see wildcard field
themeSettingsValues.*objectAdditional keys
translatedFromIdstringOptionalID of the primary blog post this object was translated from.
translationsobjectOptionalA map of translations for the blog post, each associated with a specific language variation.
Additional keys: see wildcard field
translations.*ModelAdditional keysExpand Update a post — request body — body translations value
updatedstringOptionalThe timestamp (ISO8601 format) when this Blog Post was updated.
Format: date-time
updatedByIdstringOptionalThe ID of the user that updated this Blog Post.
urlstringOptionalA generated field representing the URL of this blog post.
useFeaturedImagebooleanOptionalBoolean to determine if this post should use a featuredImage.
widgetContainersobjectOptionalA 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.*objectAdditional keys
widgetsobjectOptionalA data structure containing the data for all the modules for this page.
Additional keys: see wildcard field
widgets.*objectAdditional 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

FieldTypePresenceDescription and constraints
$objectRoot
cellsarrayRequired within parentThe cells contained within the layout section, defining its structure.
cells[]ModelEach itemExpand Update a post — request body — body layout Sections value
cssClassstringRequired within parentThe CSS class applied to the layout section.
cssIdstringRequired within parentThe CSS ID applied to the layout section.
cssStylestringRequired within parentCustom CSS styles applied to the layout section.
labelstringRequired within parentThe label for the layout section.
namestringRequired within parentThe name assigned to the layout section.
paramsobjectRequired within parentAdditional parameters for the layout section, typically used for configuration.
Additional keys: see wildcard field
params.*objectAdditional keys
rowMetaDataarrayRequired within parentMetadata associated with the rows in the layout section.
rowMetaData[]ModelEach itemExpand Update a post — request body — body layout Sections value row Meta Data item
rowsarrayRequired within parentThe number of rows in the layout section.
rows[]objectEach itemAdditional keys: see wildcard field
rows[].*ModelAdditional keysExpand Update a post — request body — body layout Sections value
stylesModelRequired within parentExpand Update a post — request body — body layout Sections value styles
typestringRequired within parentThe type of the layout section.
wintegerRequired within parentThe width of the layout section.
Format: int32
xintegerRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
cssClassstringRequired within parentThe CSS class applied to the row.
stylesModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
backgroundColorModelRequired within parentExpand Update a post — request body — body layout Sections value styles background Color
backgroundGradientModelRequired within parentExpand Update a post — request body — body layout Sections value styles background Gradient
backgroundImageModelRequired within parentExpand Update a post — response body — layout Sections value styles background Image
breakpointStylesobjectOptionalBreakpoint CSS styles for margin, padding, etc...
Additional keys: see wildcard field
breakpointStyles.*ModelAdditional keysExpand Update a post — request body — body layout Sections value styles breakpoint Styles value
flexboxPositioningstringRequired within parentIndicates 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
forceFullWidthSectionbooleanRequired within parentDetermines if the section should be forced to full width.
maxWidthSectionCenteringintegerRequired within parentDefines the maximum width for centering the section.
Format: int32
verticalAlignmentstringRequired within parentSpecifies 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

FieldTypePresenceDescription and constraints
$objectRoot
anumberRequired within parentAlpha.
bintegerRequired within parentBlue.
Format: int32
gintegerRequired within parentGreen.
Format: int32
rintegerRequired within parentRed.
Format: int32

Update a post — request body — body layout Sections value styles background Gradient

FieldTypePresenceDescription and constraints
$objectRoot
angleModelRequired within parentExpand Update a post — request body — body layout Sections value styles background Gradient angle
colorsarrayRequired within parentAn array of colors used in the gradient. Each color is represented as an RGBA value, defining the color stops in the gradient effect.
colors[]ModelEach itemExpand Update a post — request body — body layout Sections value styles background Gradient colors item
sideOrCornerModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
unitsstringRequired within parentThe unit of measurement for the angle.
One of: DEGREES, GRADIANS, RADIANS, TURNS
valuenumberRequired within parentThe numerical representation of the angle.

Update a post — request body — body layout Sections value styles background Gradient colors item

FieldTypePresenceDescription and constraints
$objectRoot
colorModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
horizontalSidestringRequired within parentSpecifies the horizontal side of an element.
One of: CENTER, LEFT, RIGHT
verticalSidestringRequired within parentSpecifies the vertical side of an element.
One of: BOTTOM, MIDDLE, TOP

Update a post — request body — body layout Sections value styles breakpoint Styles value

FieldTypePresenceDescription and constraints
$objectRoot
hiddenbooleanRequired within parentBoolean indicating if the breakpoint is visible.
marginModelRequired within parentExpand Update a post — request body — body layout Sections value styles breakpoint Styles value margin
paddingModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
bottomModelRequired within parentExpand Update a post — request body — body layout Sections value styles breakpoint Styles value margin top
topModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
unitsstringRequired within parentA 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
valuenumberRequired within parentA numeric value representing the magnitude of the size.

Update a post — request body — body layout Sections value styles breakpoint Styles value padding

FieldTypePresenceDescription and constraints
$objectRoot
bottomModelRequired within parentExpand Update a post — request body — body layout Sections value styles breakpoint Styles value margin top
leftModelRequired within parentExpand Update a post — request body — body layout Sections value styles breakpoint Styles value margin top
rightModelRequired within parentExpand Update a post — request body — body layout Sections value styles breakpoint Styles value margin top
topModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
archivedInDashboardbooleanRequired within parentIf True, the variant will not show up in your dashboard, although the post could still be live.
authorNamestringRequired within parentThe 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.
campaignstringRequired within parentThe GUID of the marketing campaign this page is a part of.
campaignNamestringRequired within parentName of the associated marketing campaign.
createdstringRequired within parentThe timestamp (ISO8601 format) when this Blog Post was created.
Format: date-time
idintegerRequired within parentID of object to set as primary in multi-language group.
Format: int64
namestringRequired within parentThe internal name of the content language variation.
passwordstringRequired within parentSet this to create a password protected page. Entering the password will be required to view the page.
publicAccessRulesarrayRequired within parentThe set of rules governing public access to this language variation.
publicAccessRules[]ModelEach itemExpand List tags — response body
publicAccessRulesEnabledbooleanRequired within parentBoolean to determine whether or not to respect publicAccessRules.
publishDatestringRequired within parentThe date (ISO8601 format) the page is to be published at.
Format: date-time
slugstringRequired within parentThe path of the this page. This field is appended to the domain to construct the url of this page.
statestringRequired within parentAn ENUM describing the current state of this page.

Maximum string length: 25
tagIdsarrayOptionalAn array of tag identifiers associated with this language variation.
tagIds[]integerEach itemFormat: int64
updatedstringRequired within parentThe timestamp (ISO8601 format) when this Blog Post was updated.
Format: date-time

Referenced models: List tags — response body

Update a post — response body

FieldTypePresenceDescription and constraints
$objectRoot
abStatusstringRequired within parentThe 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
abTestIdstringRequired within parentThe ID of the AB test associated with this page, if applicable
archivedAtJSONRequired within parent
archivedAt (anyOf 1)integerAlternativeThe timestamp (ISO8601 format) when this Blog Post was deleted.
Format: int64
archivedAt (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
archivedInDashboardbooleanRequired within parentIf True, the post will not show up in your dashboard, although the post could still be live.
attachedStylesheetsarrayRequired within parentList 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[]objectEach itemAdditional keys: see wildcard field
attachedStylesheets[].*objectAdditional keys
authorNamestringRequired within parentThe name of the user that updated this Blog Post.
blogAuthorIdstringRequired within parentThe ID of the Blog Author associated with this Blog Post.
campaignstringRequired within parentThe GUID of the marketing campaign this Blog Post is a part of.
categoryIdJSONRequired within parent
categoryId (anyOf 1)integerAlternativeID of the type of object this is. Should always .
Format: int32
categoryId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
contentGroupIdstringRequired within parentThe ID of the parent Blog this Blog Post is associated with.
contentTypeCategorystringRequired within parentAn 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
createdstringRequired within parentThe timestamp (ISO8601 format) when this Blog Post was created.
Format: date-time
createdByIdstringRequired within parentThe ID of the user that created this Blog Post.
currentStatestringRequired within parentA 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
currentlyPublishedbooleanRequired within parentWhether the post is published (true or false)
domainstringRequired within parentThe domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog.
dynamicPageDataSourceIdstringRequired within parentThe identifier for the data source used by the dynamic page.
dynamicPageDataSourceTypeJSONRequired within parent
dynamicPageDataSourceType (anyOf 1)integerAlternativeThe type of data source used by the dynamic page.
Format: int32
dynamicPageDataSourceType (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dynamicPageHubDbTableIdstringRequired within parentThe ID of the HubDB table this Blog Post references, if applicable
enableDomainStylesheetsbooleanRequired within parentBoolean to determine whether or not the styles from the template should be applied.
enableGoogleAmpOutputOverridebooleanRequired within parentBoolean to allow overriding the AMP settings for the blog.
enableLayoutStylesheetsbooleanRequired within parentBoolean to determine whether or not the styles from the template should be applied.
featuredImagestringRequired within parentThe featuredImage of this Blog Post.
featuredImageAltTextstringRequired within parentAlt Text of the featuredImage.
folderIdstringRequired within parentUnique identifier of associated folder
footerHtmlstringRequired within parentCustom HTML for embed codes, javascript that should be placed before the </body> tag of the page.
headHtmlstringRequired within parentCustom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page.
htmlTitlestringRequired within parentThe html title of this Blog Post.
idstringRequired within parentThe unique ID of the Blog Post.
includeDefaultCustomCssbooleanRequired within parentBoolean to determine whether or not the Primary CSS Files should be applied.
languagestringRequired within parentThe 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
layoutSectionsobjectRequired within parentA structure detailing the layout sections of the blog post.
Additional keys: see wildcard field
layoutSections.*ModelAdditional keysExpand Update a post — response body — layout Sections value
linkRelCanonicalUrlstringRequired within parentOptional override to set the URL to be used in the rel=canonical link tag on the page.
mabExperimentIdstringRequired within parentUnique identifier of the MAB Experiment
metaDescriptionstringRequired within parentA description that goes in <meta> tag on the page.
namestringRequired within parentThe internal name of the Blog Post.
pageExpiryDateJSONRequired within parent
pageExpiryDate (anyOf 1)integerAlternativeThe date at which this blog post should expire and begin redirecting to another url or page.
Format: int64
pageExpiryDate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageExpiryEnabledbooleanRequired within parentBoolean describing if the page expiration feature is enabled for this blog post.
pageExpiryRedirectIdJSONRequired within parent
pageExpiryRedirectId (anyOf 1)integerAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageExpiryRedirectUrlstringRequired within parentThe URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId.
passwordstringRequired within parentSet this to create a password protected page. Entering the password will be required to view the page.
postBodystringRequired within parentThe HTML of the main post body.
postSummarystringRequired within parentThe summary of the blog post that will appear on the main listing page.
publicAccessRulesarrayRequired within parentRules for require member registration to access private content.
publicAccessRules[]ModelEach itemExpand List tags — response body
publicAccessRulesEnabledbooleanRequired within parentBoolean to determine whether or not to respect publicAccessRules.
publishDatestringRequired within parentThe date (ISO8601 format) the blog post is to be published at.
Format: date-time
publishImmediatelybooleanRequired within parentSet this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.
publishedAtstringRequired within parentThe date and time when the blog post was published, in ISO 8601 format.
Format: date-time
rssBodystringRequired within parentThe contents of the RSS body for this Blog Post.
rssSummarystringRequired within parentThe contents of the RSS summary for this Blog Post.
slugstringRequired within parentThe path of the this blog post. This field is appended to the domain to construct the url of this post.
statestringRequired within parentAn ENUM descibing the current state of this Blog Post.
Maximum length: 25
tagIdsarrayRequired within parentList of IDs for the tags associated with this Blog Post.
tagIds[]JSONEach item
tagIds[] (anyOf 1)integerAlternativeFormat: int64
tagIds[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
themeSettingsValuesobjectRequired within parentA collection of settings specific to the theme applied to the blog post.
Additional keys: see wildcard field
themeSettingsValues.*objectAdditional keys
translatedFromIdstringRequired within parentID of the primary blog post this object was translated from.
translationsobjectRequired within parentA map of translations for the blog post, each associated with a specific language variation.
Additional keys: see wildcard field
translations.*ModelAdditional keysExpand Update a post — response body — translations value
updatedstringRequired within parentThe timestamp (ISO8601 format) when this Blog Post was updated.
Format: date-time
updatedByIdstringRequired within parentThe ID of the user that updated this Blog Post.
urlstringRequired within parentA generated field representing the URL of this blog post.
useFeaturedImagebooleanRequired within parentBoolean to determine if this post should use a featuredImage.
widgetContainersobjectRequired within parentA 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.*objectAdditional keys
widgetsobjectRequired within parentA data structure containing the data for all the modules for this page.
Additional keys: see wildcard field
widgets.*objectAdditional 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

FieldTypePresenceDescription and constraints
$objectRoot
cellsarrayRequired within parentThe cells contained within the layout section, defining its structure.
cells[]ModelEach itemExpand Update a post — response body — layout Sections value
cssClassstringRequired within parentThe CSS class applied to the layout section.
cssIdstringRequired within parentThe CSS ID applied to the layout section.
cssStylestringRequired within parentCustom CSS styles applied to the layout section.
labelstringRequired within parentThe label for the layout section.
namestringRequired within parentThe name assigned to the layout section.
paramsobjectRequired within parentAdditional parameters for the layout section, typically used for configuration.
Additional keys: see wildcard field
params.*objectAdditional keys
rowMetaDataarrayRequired within parentMetadata associated with the rows in the layout section.
rowMetaData[]ModelEach itemExpand Update a post — response body — layout Sections value row Meta Data item
rowsarrayRequired within parentThe number of rows in the layout section.
rows[]objectEach itemAdditional keys: see wildcard field
rows[].*ModelAdditional keysExpand Update a post — response body — layout Sections value
stylesModelRequired within parentExpand Update a post — response body — layout Sections value styles
typestringRequired within parentThe type of the layout section.
wJSONRequired within parent
w (anyOf 1)integerAlternativeThe width of the layout section.
Format: int32
w (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
xJSONRequired within parent
x (anyOf 1)integerAlternativeThe x-coordinate position of the layout section.
Format: int32
x (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
cssClassstringRequired within parentThe CSS class applied to the row.
stylesModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
backgroundColorModelRequired within parentExpand Update a post — response body — layout Sections value styles background Color
backgroundGradientModelRequired within parentExpand Update a post — response body — layout Sections value styles background Gradient
backgroundImageModelRequired within parentExpand Update a post — response body — layout Sections value styles background Image
breakpointStylesobjectOptionalBreakpoint CSS styles for margin, padding, etc...
Additional keys: see wildcard field
breakpointStyles.*ModelAdditional keysExpand Update a post — response body — layout Sections value styles breakpoint Styles value
flexboxPositioningstringRequired within parentIndicates 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
forceFullWidthSectionbooleanRequired within parentDetermines if the section should be forced to full width.
maxWidthSectionCenteringJSONRequired within parent
maxWidthSectionCentering (anyOf 1)integerAlternativeDefines the maximum width for centering the section.
Format: int32
maxWidthSectionCentering (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
verticalAlignmentstringRequired within parentSpecifies 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

FieldTypePresenceDescription and constraints
$objectRoot
aJSONRequired within parent
a (anyOf 1)numberAlternativeAlpha.
a (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
bJSONRequired within parent
b (anyOf 1)integerAlternativeBlue.
Format: int32
b (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
gJSONRequired within parent
g (anyOf 1)integerAlternativeGreen.
Format: int32
g (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rJSONRequired within parent
r (anyOf 1)integerAlternativeRed.
Format: int32
r (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a post — response body — layout Sections value styles background Gradient

FieldTypePresenceDescription and constraints
$objectRoot
angleModelRequired within parentExpand Update a post — response body — layout Sections value styles background Gradient angle
colorsarrayRequired within parentAn array of colors used in the gradient. Each color is represented as an RGBA value, defining the color stops in the gradient effect.
colors[]ModelEach itemExpand Update a post — response body — layout Sections value styles background Gradient colors item
sideOrCornerModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
unitsstringRequired within parentThe unit of measurement for the angle.
Known values: DEGREES, GRADIANS, RADIANS, TURNS
valueJSONRequired within parent
value (anyOf 1)numberAlternativeThe numerical representation of the angle.
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a post — response body — layout Sections value styles background Gradient colors item

FieldTypePresenceDescription and constraints
$objectRoot
colorModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
horizontalSidestringRequired within parentSpecifies the horizontal side of an element.
Known values: CENTER, LEFT, RIGHT
verticalSidestringRequired within parentSpecifies the vertical side of an element.
Known values: BOTTOM, MIDDLE, TOP

Update a post — response body — layout Sections value styles background Image

FieldTypePresenceDescription and constraints
$objectRoot
backgroundPositionstringRequired within parentDefines the position of the background image.
backgroundSizestringRequired within parentSpecifies the size of the background image.
imageUrlstringRequired within parentThe URL of the background image.

Update a post — response body — layout Sections value styles breakpoint Styles value

FieldTypePresenceDescription and constraints
$objectRoot
hiddenbooleanRequired within parentBoolean indicating if the breakpoint is visible.
marginModelRequired within parentExpand Update a post — response body — layout Sections value styles breakpoint Styles value margin
paddingModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
bottomModelRequired within parentExpand Update a post — response body — layout Sections value styles breakpoint Styles value margin top
topModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
unitsstringRequired within parentA 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
valueJSONRequired within parent
value (anyOf 1)numberAlternativeA numeric value representing the magnitude of the size.
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a post — response body — layout Sections value styles breakpoint Styles value padding

FieldTypePresenceDescription and constraints
$objectRoot
bottomModelRequired within parentExpand Update a post — response body — layout Sections value styles breakpoint Styles value margin top
leftModelRequired within parentExpand Update a post — response body — layout Sections value styles breakpoint Styles value margin top
rightModelRequired within parentExpand Update a post — response body — layout Sections value styles breakpoint Styles value margin top
topModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
archivedInDashboardbooleanRequired within parentIf True, the variant will not show up in your dashboard, although the post could still be live.
authorNamestringRequired within parentThe 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.
campaignstringRequired within parentThe GUID of the marketing campaign this page is a part of.
campaignNamestringRequired within parentName of the associated marketing campaign.
createdstringRequired within parentThe timestamp (ISO8601 format) when this Blog Post was created.
Format: date-time
idJSONRequired within parent
id (anyOf 1)integerAlternativeID of object to set as primary in multi-language group.
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringRequired within parentThe internal name of the content language variation.
passwordstringRequired within parentSet this to create a password protected page. Entering the password will be required to view the page.
publicAccessRulesarrayRequired within parentThe set of rules governing public access to this language variation.
publicAccessRules[]ModelEach itemExpand List tags — response body
publicAccessRulesEnabledbooleanRequired within parentBoolean to determine whether or not to respect publicAccessRules.
publishDatestringRequired within parentThe date (ISO8601 format) the page is to be published at.
Format: date-time
slugstringRequired within parentThe path of the this page. This field is appended to the domain to construct the url of this page.
statestringRequired within parentAn ENUM describing the current state of this page.

Maximum string length: 25
tagIdsarrayOptionalAn array of tag identifiers associated with this language variation.
tagIds[]JSONEach item
tagIds[] (anyOf 1)integerAlternativeFormat: int64
tagIds[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedstringRequired within parentThe timestamp (ISO8601 format) when this Blog Post was updated.
Format: date-time

Referenced models: List tags — response body

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.