There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. Your API Keys could be deactivated at any time after Nov. 30th, and we recommend that you migrate to Private Apps as soon as possible so you do not lose business-critical functionality.

Updates the auto-save buffer

Last updated June 17, 2020

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

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

Updates the auto-save buffer. Live objects will not be impacted.

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

Allowed JSON 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 /content/api/v2/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
is_draft string True if the post is still a draft, invisible to the public. Gets changed when the /publish-action API endpoint is called
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.
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
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 buffer request.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations

Example Usage and Result

Hit this URL with a HTTP method of PUT  https://api.hubapi.com/content/api/v2/blog-posts/348109414/buffer?hapikey=demo

and including a request body of

{
    "slug": "/blog/2013/10/my-first-api-blog-post",
    "post_body": "<p>Hey guys! I'm using the <b>API</b>! Woohoo!</p>",
    "post_summary": "<p>Hey guys!</p>",
    "publish_immediately": false,
    "publish_date": 1381266273000,
    "campaign": "43a0c102-4e62-4527-849a-21c9bc40c908",
    "campaign_name": "Fall 2013 Season End Clearance",
    "meta_description": "A post about posts",
    "topic_ids": [<topic_id>, <another topic_id>],
    "blog_author_id": <id of an author from the blog authors endpoint>
}