Draft Object


Blog Submodule Docs

Properties
idstringRead-onlymaxLength 38

Draft post ID.


titlestringmaxLength 200

Draft post title.


excerptstringmaxLength 500

Draft post excerpt.

If no excerpt has been manually set, an excerpt is automatically generated from the post's text. This can be retrieved using the GENERATED_EXCERPT fieldset.


featuredboolean

Whether the draft post is marked as featured.


categoryIdsArray <string>maxItems 10maxLength 38

Category IDs of the draft post.


memberIdstringformat GUID

Draft post owner's member ID.


hashtagsArray <string>maxItems 100maxLength 100

Hashtags in the post.


commentingEnabledboolean

Whether commenting on the draft post is enabled.


minutesToReadintegerRead-only

Estimated reading time of the draft post (calculated automatically).


heroImageobject

Image placed at the top of the blog page.


tagIdsArray <string>maxItems 30maxLength 38

Tag IDs the draft post is tagged with.


relatedPostIdsArray <string>maxItems 3maxLength 38

IDs of posts related to this draft post.


pricingPlanIdsArray <string>maxItems 100format GUID

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


translationIdstringformat GUID

ID of the draft post's translations.

All translations of a single post share the same translationId. Available only if the Multilingual app is installed.


languagestringformat LANGUAGE

Language the draft post is written in.

2-letter language code in ISO 639-1 alpha-2 format.


changeOriginstringRead-only
35 enum supported values:
UNKNOWNADMINADD_CATEGORIESAUTO_SAVECOPY_TEMPLATEIMPORTIMPORT_BULKIMPORT_HTMLIMPORT_PATCHLANGUAGE_CHANGEMANUAL_SAVEMIGRATIONMODERATIONMOVE_TO_TRASHPRICING_PLANS_CHANGEPROVISIONPUBLISHREASSIGN_OWNERREBLOGRESTOREREVERT_TO_DRAFTTRANSLATIONUNPUBLISHUNSCHEDULENEW_EDIT_SESSIONSCHEDULING_SERVICE_SCHEDULESCHEDULING_SERVICE_UNSCHEDULESCHEDULING_SERVICE_PUBLISHSCHEDULEREMOVE_FROM_MODERATIONREJECT_FROM_MODERATIONAPPROVE_IN_MODERATIONDELETE_TAGPINUNPIN

Reserved for internal use.


contentIdstringRead-onlymaxLength 24

Reserved for internal use.


editingSessionIdstringformat GUID

Reserved for internal use.


richContentobject

Draft Post rich content.


statusstringRead-only
7 enum supported values:
UNKNOWNPUBLISHEDUNPUBLISHEDSCHEDULEDDELETEDIN_MODERATIONIN_REVIEW

Status of the draft post.


moderationDetailsobject

Details of the draft post in review. Only relevant to posts submitted by guest writers.


mostRecentContributorIdstringRead-onlyformat GUID

Reserved for internal use.


hasUnpublishedChangesbooleanRead-only

Indicates if there are changes made to the draft post that have not yet been published.


editedDatestringRead-onlyformat date-time

Date the draft post was last edited.


scheduledPublishDatestringRead-onlyformat date-time

Date the draft post is scheduled to be published.


contentstruct

Reserved for internal use.


firstPublishedDatestringformat date-time

Date the post was first published.


seoDataobject

SEO data.


paidContentParagraphintegerdeprecated - use previewTextParagraph insteadminimum 0format int32

Reserved for internal use.


slugsArray <string>Read-onlymaxItems 5000maxLength 100

Reserved for internal use.


urlobjectRead-only

Draft post URL preview. What the URL will look like once the post is published.


createdDatestringRead-onlyformat date-time

Date the draft post was first created.


seoSlugstringmaxLength 100

SEO slug.


mediaobject

Post cover media.


previewTextParagraphintegerminimum 0format int32

Number of paragraphs to display in a paid content preview for non-paying users.


internalIdstringRead-onlymaxLength 24

Reserved for internal use.

Was this helpful?
Yes
No