Post Object


The Post object represents the information for published blog posts.

Properties
categoryIdsArray <string>maxItems 10format GUID

Category IDs of the post. See Blog Category API for more info.


commentingEnabledboolean

Whether commenting on the post is enabled.


contactIdstringformat GUID

Contact ID of the post's owner. See the Contacts API for more info.


contentTextstringRead-onlymaxLength 400000

The post's content in plain text.


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.


heroImageImage

Image placed at the top of the blog page. Only displays on mobile devices.


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

Member ID of the post's owner.


minutesToReadinteger

Estimated reading time (calculated automatically).


moderationDetailsModerationDetailsRead-only

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

Guest writers have the ability to write posts but not publish them. These posts can be rejected or approved for publishing by a blog editor or Wix user.


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. See the Pricing Plans API for more info.

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

seoDataSeoSchema

SEO data.


slugstringmaxLength 100

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


tagIdsArray <string>Read-onlymaxItems 30format GUID

IDs of tags the post is tagged with. See Blog Tags API for more info.


titlestringmaxLength 200

Post title.


translationIdstringformat GUID

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


urlPageUrl

Post URL.

Did this help?