Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 12.x
  • Verint Community
Verint Community 12.x
API Documentation core_v2_blogPost Script API
  • User Documentation
  • Ask the Community
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • +In-Process API Documentation
  • +Plugin API Documentation
  • +REST API Documentation
  • -Widget, Theme, and Automation APIs
    • +Automation Events
    • +Client-side APIs
    • +Dynamic Configuration
    • +LESS Functions
    • +Script API Types
    • -Script APIs
      • articles_v1_articleCategories Script API
      • articles_v1_articleCollections Script API
      • articles_v1_articles Script API
      • articles_v1_articleTypes Script API
      • articles_v1_articleUrls Script API
      • articles_v1_articleVersionCategories Script API
      • articles_v1_articleVersions Script API
      • articles_v1_categories Script API
      • articles_v1_helpfulness Script API
      • articles_v1_helpfulnessResponseTypes Script API
      • articles_v1_permissions Script API
      • articles_v1_publishGroups Script API
      • articles_v1_subscriptionTypes Script API
      • calendar_v1_calendars Script API
      • calendar_v1_events Script API
      • calendar_v1_permissions Script API
      • calendar_v1_registrations Script API
      • calendar_v1_resources Script API
      • calendar_v1_UI Script API
      • calendar_v1_urls Script API
      • context_v2_automationState Script API
      • context_v2_automationTrigger Script API
      • context_v2_embeddable Script API
      • context_v2_propertyRule Script API
      • context_v2_propertyTemplate Script API
      • context_v2_scheduledFile Script API
      • context_v2_themeBody Script API
      • context_v2_themeHeader Script API
      • core_v1_reportingPermissions Script API
      • core_v1_reportingUrls Script API
      • core_v2_abuseAppeal Script API
      • core_v2_abuseReport Script API
      • core_v2_abusiveContent Script API
      • core_v2_achievement Script API
      • core_v2_achievementSummary Script API
      • core_v2_activityStory Script API
      • core_v2_activityStorySitePreference Script API
      • core_v2_activityStoryUserPreference Script API
      • core_v2_apiKey Script API
      • core_v2_application Script API
      • core_v2_applicationMerge Script API
      • core_v2_applicationSubscription Script API
      • core_v2_applicationType Script API
      • core_v2_authentication Script API
      • core_v2_authorQualityScore Script API
      • core_v2_automation Script API
      • core_v2_blog Script API
      • core_v2_blogConfiguration Script API
      • core_v2_blogPermissions Script API
      • core_v2_blogPost Script API
      • core_v2_blogPostSummary Script API
      • core_v2_blogUrls Script API
      • core_v2_bookmark Script API
      • core_v2_calculatedScores Script API
      • core_v2_captureThreadToArticle Script API
      • core_v2_cfs Script API
      • core_v2_comments Script API
      • core_v2_commentSummary Script API
      • core_v2_commentVotes Script API
      • core_v2_configuration Script API
      • core_v2_container Script API
      • core_v2_containerType Script API
      • core_v2_content Script API
      • core_v2_contentConversion Script API
      • core_v2_contentPresence Script API
      • core_v2_contentQualityScore Script API
      • core_v2_contentRecommendation Script API
      • core_v2_contentSubscribers Script API
      • core_v2_contentSubscription Script API
      • core_v2_contentType Script API
      • core_v2_contentViews Script API
      • core_v2_conversation Script API
      • core_v2_conversationMessage Script API
      • core_v2_customNavigation Script API
      • core_v2_customPage Script API
      • core_v2_dynamicForm Script API
      • core_v2_editableGroup Script API
      • core_v2_editor Script API
      • core_v2_email Script API
      • core_v2_emailDigest Script API
      • core_v2_emoticon Script API
      • core_v2_encoding Script API
      • core_v2_eventLog Script API
      • core_v2_exceptions Script API
      • core_v2_follower Script API
      • core_v2_following Script API
      • core_v2_forum Script API
      • core_v2_forumConfiguration Script API
      • core_v2_forumPermissions Script API
      • core_v2_forumReply Script API
      • core_v2_forumReplyVote Script API
      • core_v2_forumThread Script API
      • core_v2_forumThreadVote Script API
      • core_v2_forumUrls Script API
      • core_v2_friendship Script API
      • core_v2_gallery Script API
      • core_v2_group Script API
      • core_v2_groupAuthorQualityScore Script API
      • core_v2_groupContactRequest Script API
      • core_v2_groupPermissions Script API
      • core_v2_groupRoleMember Script API
      • core_v2_groupUrls Script API
      • core_v2_groupUserMember Script API
      • core_v2_hashTag Script API
      • core_v2_http Script API
      • core_v2_infoResult Script API
      • core_v2_language Script API
      • core_v2_ldapGroups Script API
      • core_v2_ldapUsers Script API
      • core_v2_leader Script API
      • core_v2_leaderboard Script API
      • core_v2_leaderboardUrls Script API
      • core_v2_like Script API
      • core_v2_likedItem Script API
      • core_v2_media Script API
      • core_v2_mediaConfiguration Script API
      • core_v2_mediaPermissions Script API
      • core_v2_mediaUrls Script API
      • core_v2_mention Script API
      • core_v2_mentionable Script API
      • core_v2_message Script API
      • core_v2_moderationTemplates Script API
      • core_v2_notification Script API
      • core_v2_notificationCategory Script API
      • core_v2_notificationDistributionType Script API
      • core_v2_notificationType Script API
      • core_v2_notificationUserPreference Script API
      • core_v2_oauthClient Script API
      • core_v2_page Script API
      • core_v2_permission Script API
      • core_v2_pointTransaction Script API
      • core_v2_poll Script API
      • core_v2_process Script API
      • core_v2_ratedItem Script API
      • core_v2_rating Script API
      • core_v2_reviewableContent Script API
      • core_v2_role Script API
      • core_v2_roleUsers Script API
      • core_v2_rssFeedItem Script API
      • core_v2_search Script API
      • core_v2_searchCategory Script API
      • core_v2_searchResult Script API
      • core_v2_servicePresence Script API
      • core_v2_sitePermissions Script API
      • core_v2_statusMessage Script API
      • core_v2_submittableEditor Script API
      • core_v2_systemNotification Script API
      • core_v2_taggedContent Script API
      • core_v2_tags Script API
      • core_v2_theme Script API
      • core_v2_themeFooter Script API
      • core_v2_themeHeader Script API
      • core_v2_themePage Script API
      • core_v2_tourTip Script API
      • core_v2_ui Script API
      • core_v2_uploadedFile Script API
      • core_v2_urls Script API
      • core_v2_user Script API
      • core_v2_userAchievement Script API
      • core_v2_userFile Script API
      • core_v2_userFolder Script API
      • core_v2_userInvitation Script API
      • core_v2_userPermission Script API
      • core_v2_userProfileField Script API
      • core_v2_userProfileFieldGroup Script API
      • core_v2_userRecommendation Script API
      • core_v2_userValidation Script API
      • core_v2_utility Script API
      • core_v2_webhook Script API
      • core_v2_webhookEvent Script API
      • core_v2_widget Script API
      • core_v2_wiki Script API
      • core_v2_wikiConfiguration Script API
      • core_v2_wikiFiles Script API
      • core_v2_wikiPage Script API
      • core_v2_wikiPageCommentSubscriptions Script API
      • core_v2_wikiPageRevision Script API
      • core_v2_wikiPermissions Script API
      • core_v2_wikiToc Script API
      • core_v2_wikiUrls Script API
      • core_v3_feature Script API
      • core_v3_permission Script API
      • telligentIdeas_v1_challenges Script API
      • telligentIdeas_v1_ideaCategories Script API
      • telligentIdeas_v1_ideaPermissions Script API
      • telligentIdeas_v1_ideas Script API
      • telligentIdeas_v1_ideaStatuses Script API
      • telligentIdeas_v1_statuses Script API
      • telligentIdeas_v1_urls Script API
      • telligentIdeas_v1_userVoteSummaries Script API
      • telligentIdeas_v1_votes Script API

core_v2_blogPost Script API


Enables scripted content fragments to use BlogPosts

  • Properties
  • AreRatingsEnabled
  • Create
  • Delete
  • Get
  • GetRating
  • IncrementViewCount
  • IsSubscribed
  • List
  • SetRating
  • SetSubscribed
  • Update

Properties

NameAccessTypeDescription
BlogPostContentViewTypeIdReadGuid
Obsolete. Obsolete in v12.1: Use the default view type '00000000-0000-0000-0000-000000000000' instead.
Id used to track a view to the blog post. DEPRECATED in v12.1: Use the default view type '00000000-0000-0000-0000-000000000000' instead.
ContentTypeIdReadGuidBlog posts content type identifier
CurrentReadBlogPostReturns the current contextual blog post

Methods

AreRatingsEnabled

Returns whether ratings are enabled on a thread. DEPRECATED: Use $core_v2_rating.CanCreate() instead.

Velocity

#set($booleanResponse = $core_v2_blogPost.AreRatingsEnabled($blogPostId))

JavaScript

var booleanResponse = core_v2_blogPost.AreRatingsEnabled(blogPostId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdInt32Blog Post IdRequired

Returns

Boolean

Create

Create Overload 1

Creates a new blog post

Velocity

#set($blogPostResponse = $core_v2_blogPost.Create($blogId, $title, $body))

JavaScript

var blogPostResponse = core_v2_blogPost.Create(blogId, title, body);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdInt32Blog IdRequired
titleStringTitleRequired
bodyStringBodyRequired

Create Overload 2

Creates a new blog post

Velocity

#set($blogPostResponse = $core_v2_blogPost.Create($blogId, $title, $body, "%{ AuthorId = $authorIdArg, ContentType = $contentTypeArg, Excerpt = $excerptArg, ExtendedAttributes = $extendedAttributesArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, IsApproved = $isApprovedArg, IsFeatured = $isFeaturedArg, MetaDescription = $metaDescriptionArg, MetaKeywords = $metaKeywordsArg, MetaTitle = $metaTitleArg, OpenGraphDescription = $openGraphDescriptionArg, OpenGraphImageContext = $openGraphImageContextArg, OpenGraphImageFileName = $openGraphImageFileNameArg, OpenGraphTitle = $openGraphTitleArg, PostImageAlternateText = $postImageAlternateTextArg, PostImageFileData = $postImageFileDataArg, PostImageFileName = $postImageFileNameArg, PostImageFileUploadContext = $postImageFileUploadContextArg, PostImageUrl = $postImageUrlArg, PublishedDate = $publishedDateArg, Slug = $slugArg, Tags = $tagsArg }"))

JavaScript

var blogPostResponse = core_v2_blogPost.Create(blogId, title, body, { AuthorId: authorIdArg, ContentType: contentTypeArg, Excerpt: excerptArg, ExtendedAttributes: extendedAttributesArg, FeaturedImage: featuredImageArg, FileData: fileDataArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg, FileUrl: fileUrlArg, IsApproved: isApprovedArg, IsFeatured: isFeaturedArg, MetaDescription: metaDescriptionArg, MetaKeywords: metaKeywordsArg, MetaTitle: metaTitleArg, OpenGraphDescription: openGraphDescriptionArg, OpenGraphImageContext: openGraphImageContextArg, OpenGraphImageFileName: openGraphImageFileNameArg, OpenGraphTitle: openGraphTitleArg, PostImageAlternateText: postImageAlternateTextArg, PostImageFileData: postImageFileDataArg, PostImageFileName: postImageFileNameArg, PostImageFileUploadContext: postImageFileUploadContextArg, PostImageUrl: postImageUrlArg, PublishedDate: publishedDateArg, Slug: slugArg, Tags: tagsArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdInt32Id of parent blogRequired
titleStringTitle of blog postRequired
bodyStringContent of blog postRequired
optionsOptionsSet of optional parameters including:Required
AuthorIdInt32User who authored the blog post. If not provided, the accessing user authored the blog. Used when creating a blog post on behalf of the author.Optional
ContentTypeStringUsed when adding a post attachment.Optional
ExcerptStringExcerptOptional
ExtendedAttributesStringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
FeaturedImageStringUsed to include a featured image when IsFeatured is true.Optional
FileDataArray of ByteWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required. OBSOLETE in 12: Use FileUrl or FileUploadContext instead.Optional
FileNameStringUsed when adding a post attachment.Optional
FileUploadContextStringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileUrlStringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
IsApprovedBooleanWhether the moderation state should be approvedOptionalTrue
IsFeaturedBooleanWhether the post should be featuredOptionalFalse
MetaDescriptionStringDescription used in meta description tag.Optional
MetaKeywordsStringKeywords for the meta keyword tag.Optional
MetaTitleStringTitle used in page's title tag.Optional
OpenGraphDescriptionStringDescription used in Open Graph description tag.Optional
OpenGraphImageContextStringWhen adding a an Open Graph image either OpenGraphImageData or OpenGraphImageContext is required.Optional
OpenGraphImageFileNameStringUsed when adding an Open Graph imageOptional
OpenGraphTitleStringTitle used in Open Graph title tag.Optional
PostImageAlternateTextStringAlternate Text for the Post Image.Optional
PostImageFileDataArray of ByteWhen adding a post attachment either PostImageFileData, PostImageUrl or PostImageFileUploadContext is required. OBSOLETE in 12: Use PostImageUrl or PostImageFileUploadContext instead.Optional
PostImageFileNameStringUsed when adding a post image.Optional
PostImageFileUploadContextStringWhen adding a post attachment either PostImageFileData, PostImageFileUrl or PostImageFileUploadContext is required.Optional
PostImageUrlStringWhen adding a post attachment either PostImageFileData, PostImageFileUrl or PostImageFileUploadContext is required.Optional
PublishedDateDateTimeIf PublishedDate is not specified it will default to current date/time.Optional
SlugStringIf not specified slug will be automatically created based on post title.Optional
TagsStringA comma separated list of tags.Optional

Returns

BlogPost

Delete

Delete Overload 1

Deletes a blog post

Velocity

#set($additionalInfoResponse = $core_v2_blogPost.Delete($id))

JavaScript

var additionalInfoResponse = core_v2_blogPost.Delete(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32Id of the blog postRequired

Delete Overload 2

Deletes a blog post

Velocity

#set($additionalInfoResponse = $core_v2_blogPost.Delete($id, "%{}"))

JavaScript

var additionalInfoResponse = core_v2_blogPost.Delete(id, {});

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32Id of the blog postRequired
optionsOptionsSet of optional parameters including:Required

Returns

AdditionalInfo

Get

Get Overload 1

Gets a blog post

Velocity

#set($blogPostResponse = $core_v2_blogPost.Get("%{ BlogId = $blogIdArg, EnablePendingReview = $enablePendingReviewArg, Id = $idArg, Name = $nameArg }"))

JavaScript

var blogPostResponse = core_v2_blogPost.Get({ BlogId: blogIdArg, EnablePendingReview: enablePendingReviewArg, Id: idArg, Name: nameArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
BlogIdInt32Id of the parent blogOptional
EnablePendingReviewBooleanWhen true, enables retrieving edits to the blog post that are currently pending review authored by the accessing user.OptionalFalse
IdInt32Either the Id or the Name (key) is required.Optional
NameStringEither the Id or the Name (key) is required.Optional

Get Overload 2

Gets a blog post

Velocity

#set($blogPostResponse = $core_v2_blogPost.Get($contentId))

JavaScript

var blogPostResponse = core_v2_blogPost.Get(contentId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired

Returns

BlogPost

GetRating

Gets the rating. DEPRECATED: Use $core_v2_ratedItem.Get() instead.

Velocity

#set($ratingResponse = $core_v2_blogPost.GetRating($blogPostId))

JavaScript

var ratingResponse = core_v2_blogPost.GetRating(blogPostId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdInt32Blog Post IdRequired

Returns

Rating

IncrementViewCount

Increments the view count for a blog post

Velocity

$core_v2_blogPost.IncrementViewCount($blogPostId)

JavaScript

core_v2_blogPost.IncrementViewCount(blogPostId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdInt32Blog Post IdRequired

Returns

Nothing

IsSubscribed

IsSubscribed Overload 1

Returns subscribed status for the accessing user

Velocity

#set($booleanResponse = $core_v2_blogPost.IsSubscribed($blogPostId, "%{ IncludeApplicationSubscriptions = $includeApplicationSubscriptionsArg }"))

JavaScript

var booleanResponse = core_v2_blogPost.IsSubscribed(blogPostId, { IncludeApplicationSubscriptions: includeApplicationSubscriptionsArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdInt32Blog Post IdRequired
optionsOptionsSet of optional parameters including:Required
IncludeApplicationSubscriptionsBooleanWhen false, this will only show the subscription status of the content itself, ignorning any application level subscriptions.OptionalTrue

IsSubscribed Overload 2

Returns subscribed status for the accessing user

Velocity

#set($booleanResponse = $core_v2_blogPost.IsSubscribed($blogPostId))

JavaScript

var booleanResponse = core_v2_blogPost.IsSubscribed(blogPostId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdInt32Blog Post IdRequired

Returns

Boolean

List

Lists blog posts

Velocity

#set($pagedListResponse = $core_v2_blogPost.List("%{ AuthorId = $authorIdArg, BlogId = $blogIdArg, BlogIds = $blogIdsArg, ContentIds = $contentIdsArg, DateFilter = $dateFilterArg, DateFilterType = $dateFilterTypeArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, IncludeUnpublished = $includeUnpublishedArg, LogicallyOrTags = $logicallyOrTagsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, Tags = $tagsArg }"))

JavaScript

var pagedListResponse = core_v2_blogPost.List({ AuthorId: authorIdArg, BlogId: blogIdArg, BlogIds: blogIdsArg, ContentIds: contentIdsArg, DateFilter: dateFilterArg, DateFilterType: dateFilterTypeArg, GroupId: groupIdArg, IncludeSubGroups: includeSubGroupsArg, IncludeUnpublished: includeUnpublishedArg, LogicallyOrTags: logicallyOrTagsArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, Tags: tagsArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
AuthorIdInt32Id of authorOptional
BlogIdInt32Blog to filter by.Optional
BlogIdsStringUsed to filter by a list of blogs. Multiple values are separated with commas.Optional
ContentIdsStringComma separated list of ContentIds. Used to limit to a specific set of blog posts as well as sort order if SortBy is set to ContentIdsOrderOptional
DateFilterStringA DateTime value used to filter postsOptional
DateFilterTypeStringOnly used when using a DateFilter.OptionalDay, Month, Year
GroupIdInt32Group to filter by.Optional
IncludeSubGroupsBooleanOnly used when GroupId is specified.OptionalFalse
IncludeUnpublishedBooleandefines whether to include unpublished posts in the response. OptionalFalse
LogicallyOrTagsBooleanFilter posts by tags with OROptionalFalse
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page.Optional20
SortByStringSort ByOptionalMostRecentContentIdsOrder, MostComments, MostRecent, MostViewed, Score:SCORE_ID
SortOrderStringSort OrderOptionalAscendingAscending, Descending
TagsStringComma separated list of tagsOptional

Returns

PagedList of BlogPost

SetRating

Sets the rating for the accessing user. DEPRECATED: Use $core_v2_rating.Create() instead.

Velocity

$core_v2_blogPost.SetRating($blogPostId, $rating)

JavaScript

core_v2_blogPost.SetRating(blogPostId, rating);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdInt32Blog Post IdRequired
ratingInt32RatingRequired

Returns

Nothing

SetSubscribed

Sets subscribed status for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_blogPost.SetSubscribed($blogPostId, $subscribe))

JavaScript

var additionalInfoResponse = core_v2_blogPost.SetSubscribed(blogPostId, subscribe);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdInt32Blog Post IdRequired
subscribeBooleanSubscribed StatusRequired

Returns

AdditionalInfo

Update

Updates a blog post

Velocity

#set($blogPostResponse = $core_v2_blogPost.Update($id, "%{ AuthorId = $authorIdArg, BlogId = $blogIdArg, Body = $bodyArg, ContentType = $contentTypeArg, Excerpt = $excerptArg, ExtendedAttributes = $extendedAttributesArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, IsApproved = $isApprovedArg, IsFeatured = $isFeaturedArg, MetaDescription = $metaDescriptionArg, MetaTitle = $metaTitleArg, OpenGraphDescription = $openGraphDescriptionArg, OpenGraphImageContext = $openGraphImageContextArg, OpenGraphImageFileName = $openGraphImageFileNameArg, OpenGraphTitle = $openGraphTitleArg, PostImageAlternateText = $postImageAlternateTextArg, PostImageFileData = $postImageFileDataArg, PostImageFileName = $postImageFileNameArg, PostImageFileUploadContext = $postImageFileUploadContextArg, PostImageUrl = $postImageUrlArg, PublishedDate = $publishedDateArg, RemoveAttachment = $removeAttachmentArg, RemoveOpenGraphImage = $removeOpenGraphImageArg, RemovePostImage = $removePostImageArg, Slug = $slugArg, Tags = $tagsArg, Title = $titleArg }"))

JavaScript

var blogPostResponse = core_v2_blogPost.Update(id, { AuthorId: authorIdArg, BlogId: blogIdArg, Body: bodyArg, ContentType: contentTypeArg, Excerpt: excerptArg, ExtendedAttributes: extendedAttributesArg, FeaturedImage: featuredImageArg, FileData: fileDataArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg, FileUrl: fileUrlArg, IsApproved: isApprovedArg, IsFeatured: isFeaturedArg, MetaDescription: metaDescriptionArg, MetaTitle: metaTitleArg, OpenGraphDescription: openGraphDescriptionArg, OpenGraphImageContext: openGraphImageContextArg, OpenGraphImageFileName: openGraphImageFileNameArg, OpenGraphTitle: openGraphTitleArg, PostImageAlternateText: postImageAlternateTextArg, PostImageFileData: postImageFileDataArg, PostImageFileName: postImageFileNameArg, PostImageFileUploadContext: postImageFileUploadContextArg, PostImageUrl: postImageUrlArg, PublishedDate: publishedDateArg, RemoveAttachment: removeAttachmentArg, RemoveOpenGraphImage: removeOpenGraphImageArg, RemovePostImage: removePostImageArg, Slug: slugArg, Tags: tagsArg, Title: titleArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32Id of the blog post to updateRequired
optionsOptionsSet of optional parameters including:Required
AuthorIdInt32User who authored the blog post. If not provided, the accessing user authored the blog. Used when creating a blog post on behalf of the author.Optional
BlogIdInt32Id of parent blogOptional
BodyStringContent of blog postOptional
ContentTypeStringUsed when adding a post attachment.Optional
ExcerptStringExcerptOptional
ExtendedAttributesStringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
FeaturedImageStringUsed to include a featured image when IsFeatured is true.Optional
FileDataArray of ByteWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required. OBSOLETE in 12: Use FileUrl or FileUploadContext instead.Optional
FileNameStringUsed when adding a post attachment.Optional
FileUploadContextStringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileUrlStringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
IsApprovedBooleanWhether the moderation state should be approvedOptionalTrue
IsFeaturedBooleanWhether the post should be featuredOptionalFalse
MetaDescriptionStringDescription used in meta description tag.Optional
MetaTitleStringTitle used in page's title tag.Optional
OpenGraphDescriptionStringDescription used in Open Graph title tag.Optional
OpenGraphImageContextStringWhen adding a an Open Graph image either OpenGraphImageData or OpenGraphImageContext is required.Optional
OpenGraphImageFileNameStringUsed when adding an Open Graph imageOptional
OpenGraphTitleStringTitle used in Open Graph title tag.Optional
PostImageAlternateTextStringAlternate Text for the Post Image.Optional
PostImageFileDataArray of ByteWhen adding a post attachment either PostImageFileData, PostImageFileUrl or PostImageFileUploadContext is required. OBSOLETE in 12: Use PostImageUrl or PostImageFileUploadContext instead.Optional
PostImageFileNameStringUsed when adding a post image.Optional
PostImageFileUploadContextStringWhen adding a post attachment either PostImageFileData, PostImageUrl or PostImageFileUploadContext is required.Optional
PostImageUrlStringWhen adding a post attachment either PostImageFileData, PostImageUrl or PostImageFileUploadContext is required.Optional
PublishedDateDateTimeIf PublishedDate is not specified it will default to current date/time.Optional
RemoveAttachmentBooleanWhen true, removes the post's attachmentOptionalFalse
RemoveOpenGraphImageBooleanWhen true, removes the post's open graph imageOptionalFalse
RemovePostImageBooleanWhen true, removes the post's imageOptionalFalse
SlugStringIf not specified slug will be automatically created based on post title.Optional
TagsStringA comma separated list of tags.Optional
TitleStringTitle of blog postOptional

Returns

BlogPost


  • Share
  • History
  • More
  • Cancel
Related
Recommended
  • Telligent
  • Professional Services
  • Submit a Support Ticket
  • Become a Partner
  • Request a Demo
  • Contact Us

About
Privacy Policy
Terms of use
Copyright 2024 Verint, Inc.
Powered by Verint Community