Update the blog post

PUT /content/api/v2/blog-posts/:blog_post_id

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Update a blog post.
If any fields are omitted from the body, we will only update the included fields.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
blog_post_id Used in the request URL Unique identifier for a particular blog

AllowedJSON Fields in the body

Parameter name Type Description
blog_author_id long The integer id of the blog author, look up via the blog authors end point /blogs/v3/blog-authors
campaign string The guid of the marketing campaign this post is associated with
campaign_name string The name of the marketing campaign this post is associated with
content_group_id long The id of the blog that this post belongs to. Get the id by looking at the blog API endpoint /content/api/v2/blogs
footer_html string Custom HTML for embed codes, javascript that should be placed before the </body> tag of the page
head_html string Custom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page
keywords list A JSON list of keywords and their GUIDs. This list contains key value pairs of "keyword" and "keyword_guid". For example:
  • "keyword" : "sandwiches",
  • "keyword_guid" : "ee7c2292-7a2f-4f0f-81fb-ad0bd9ca4fcb"
The GUID is available from the Keywords API. This list adds keywords to the Optimization tab in HubSpot.
meta_description string A description that goes in <meta> tag on the page
name string The internal name of the blog post
post_body string The HTML of the main post body
post_summary string The summary of the blog post that will appear on the main listing page
publish_date long The date the blog post is to be published at in milliseconds since the unix epoch. Note that even if this is set to the past or current time, you still need to call the Publish or unpublish a blog post endpoint to trigger a publish event.
publish_immediately string Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting. Note that even if this is set to true, you still need to call the Publish or unpublish a blog post endpoint to trigger a publish event.
slug string The path of the URL on which the post will live. Changing this will change the URL.
topic_ids list A json list of topic ids from the topics API ( /content/api/v2/topics )
widgets string A data structure containing the data for all the modules for this post. This will only be populated if the blog template has editable widgets defined.

Expected Response

A successful PUT will result in a 200 response. The body of the response will be identical to a GET request.