Table of Contents


Article Type

Provides access to the definition and settings of an Article; this entity is the parent of Article Posts.

The API name of this entity is "Blog".
 

API NameLabelRequiredData TypeDescription
AllowRecallAllow Submission RecallNoCheckboxAllows authors to recall a submitted article before it’s published.
ApprovalProcessApproval ProcessNoPicklistSelects which approval workflow applies to this article type.
Values: Default or Custom.
BlogListIdArticle ListYesLookup(Article List)Associates the article with a specific list or category.
BlogNameAPI NameYesText(80)Unique API identifier for the article type.
CommentAcknowledgementTemplateIdComment Acknowledgement TemplateYesLookup(Email Template)Email template used to acknowledge receipt of a comment.
CommentConfirmationTemplateIdComment Confirmation TemplateNoLookup(Email Template)Email template sent to commenters after moderation.
CommentModerationComment ModerationNoCheckboxEnables moderation queue for incoming comments.
CommentRecipientsComment RecipientsNoTextArea(32 000)Comma-separated list of users/emails notified when new comments arrive.
CommentsEnabledEnable CommentsNoCheckboxToggles whether end-users can post comments on articles.
CreatedByIdCreated ByNoLookup(User)User who originally created this record.
CreatedOnCreated OnNoDateTimeTimestamp when the record was first created.
DateSettingDate SettingNoPicklistSpecifies which date value should be shown on posts.
Values: Show Publish Date, Show Last Modified Date, Hidden.
DescriptionDescriptionNoTextArea(512)Free-form description of the article type’s purpose or notes.
DisableSocialSharingDisable Social SharingNoCheckboxWhen checked, hides social-share buttons on article pages.
EditLockedPostEdit Locked PostNoPicklistDefines who may edit posts once they’re locked.
Values: Admin, Admin and approver(s) of current step.
FeedProviderUrlFeed Provider URLNoURLRSS/Atom feed endpoint for external syndication.
HideSidebarHide SidebarNoCheckboxRemoves the sidebar on article-detail pages.
IdIdNoIDSystem-generated, unique record identifier.
IsDeletedDeletedNoCheckboxSoft-delete flag (true if the record is in the recycle bin).
LanguageLanguageNoText(5)ISO code (e.g. “en”, “fr”) for locale-specific article types.
ListStyleList StyleNoPicklistDetermines appearance articles' list view.
Values: Simple List of Posts, Posts with Author Picture, Posts with Blog Picture, Posts with Small Blog Picture, Tile List of Posts.
ModifiedByIdModified ByNoLookup(User)User who last updated this record.
ModifiedOnModified OnNoDateTimeTimestamp of the most recent update.
NameNameYesText(120)Human-readable label for this article type.
NotificationModeNotification ModeNoPicklistControls how subscribers are notified (New Posts, New Posts and Comments).
OrderNumberOrder NumberNoNumber(3,0)Integer used to sort article types in lists.
OwnerIdOwnerNoLookup(User)Record owner (used for permissions and sharing).
PageSizePage SizeNoNumber(5,0)Number of articles shown per page in list-views.
RatingTypeRating TypeNoPicklistSelects the rating widget (stars, thumbs up/down).
Values: 5-Star Rating, Like/Dislike
RequireLoginRequire LoginNoCheckboxIf checked, only authenticated users may view articles.
SearchPositionSearch PositionNoPicklistPlacement of search bar on article listing pages.
Values: Page Sidebar, Top of Page, Hidden.
SecurityTypeSecurityNoPicklistVisibility model (public, private, role-based) for articles. This property is read-only.
Values: Public, Members Only, Internal, Limited Access, Private.
ShowAuthorShow AuthorNoCheckboxToggles display of the author’s name on articles.
ShowCategoriesShow CategoriesNoCheckboxToggles display of assigned categories.
ShowLanguageFilterShow Language FilterNoCheckboxDisplays a language-selection filter on article lists.
ShowMapViewShow Map ViewNoCheckboxEnables geolocation map view for articles (if location data is set).
ShowPopularTagsShow Popular TagsNoCheckboxDisplays a “popular tags” widget based on tag usage.
ShowRatingEnable RatingNoCheckboxShows the rating component on article pages.
ShowTagCloudEnable Post TagsNoCheckboxRenders a tag-cloud of all tags used in this article type.
StatusStatusNoPicklistActive/inactive flag for the article type itself.
SubscribersSubscribersNoPicklistDefines which user groups are auto-subscribed to new articles.
Values: Do not track Subscribers, All users who explicitly subscribe, All users with access are considered as subscribers.
VersionControlEnabledEnable Version ControlNoCheckboxTurns on version history and rollback for articles of this type.
WordVerificationWord VerificationNoCheckboxRequires CAPTCHA/word-verification before posting comments.