Post Object


The Post object represents the information for published blog posts.

Properties
categoryIdsArray <string>maxItems 10format GUID

Category IDs of the post.


commentingEnabledboolean

Whether commenting on the post is enabled.


contactIdstringformat GUID

Post owner's contact ID.


contentstringRead-onlymaxLength 400000

Reserved for internal use.


contentIdstringmaxLength 24

Reserved for internal use.


contentTextstringRead-onlymaxLength 400000

The post's content in plain text.


coverMediaCoverMediadeprecated - use media instead

Deprecated. Use media instead. This property will be removed on June 30, 2023.

Post cover media.


excerptstringmaxLength 500

Post excerpt. Can be selected by a site contributor. By default, it is extracted from the content text's first characters.

Max: 500 characters


featuredboolean

Whether the post is marked as featured.


firstPublishedDatestringformat date-time

Date the post was first published.


hashtagsArray <string>Read-onlymaxItems 100maxLength 100

Hashtags in the post.


hasUnpublishedChangesbooleanRead-only

Indicates if there is a draft post with changes that have not yet been published.


heroImageHeroImage

Image placed at the top of the blog page.


idstringRead-onlyformat GUID

Post ID.


languagestringformat LANGUAGE_TAG

Language the post is written in.

2-or-4-letter language code in IETF BCP 47 language tag format.


lastPublishedDatestringRead-onlyformat date-time

Date the post was last published.


mediaMedia

Post cover media.


memberIdstringformat GUID

Post owner's member ID.


minutesToReadinteger

Estimated reading time (calculated automatically).


moderationDetailsModerationDetailsRead-only

Post moderation details. Only relevant to posts submitted by guest writers.


mostRecentContributorIdstringRead-onlyformat GUID

Reserved for internal use.


pinnedboolean

Whether the post is pinned. If true, the post is placed at the top of the post list.


previewbooleanRead-only

Whether the returned content is a preview of premium content. Defaults to false. A preview displays a limited number of paragraphs of paid content to non-subscribed users.


pricingPlanIdsArray <string>Read-onlymaxItems 100format GUID

Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan.


referenceIdstringRead-onlymaxLength 24

Post reference ID. You can reference the post from other entities, for example, comments.


relatedPostIdsArray <string>Read-onlymaxItems 3format GUID

IDs of posts related to the post.


richContentRichContentRead-only

Post rich content

See Ricos document reference

seoDataSeoData

SEO data.


slugstringmaxLength 100

Post slug. For example, 'post-slug'.


tagIdsArray <string>Read-onlymaxItems 30format GUID

IDs of tags the post is tagged with.


titlestringmaxLength 100

Post title.


translationIdstringformat GUID

ID of the translations of this post. All translations of a single post share the same translationId.


urlUrl

Post URL.

Did this help?