There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Create a new comment

Last updated May 31, 2023

POST /comments/v3/comments

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

Create a new comment.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.

Example Usage and Result

Hit this URL with a HTTP method of POST  http://api.hubapi.com/comments/v3/comments

This API is considered content agnostic, meaning it may record data for more than a single type of object (a blog post or a landing page, etc.) Due to this difference, the API requires additional fields that may seem redundant if the API were only concerned with a single type.

Required JSON Fields in the body

Parameter name Type Description
comment string The full text of the comment
contentId long The id of the parent blog post
collectionId long The ID of the blog that the post is a part of. You can get the blog ID through the Blog API
contentAuthorEmail string The email address of the blog post author
contentAuthorName string The name of the blog post author
contentPermalink string URL to the blog post
contentTitle string Title of the blog post
userEmail string The email address of the comment author
userName string The name of the comment author
userUrl string The homepage of the comment author (Optional)

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 POST URL: https://api.hubapi.com/comments/v3/comments Example POST body: { "comment":"This is a test blog comment", "contentId":"6513512292", "collectionId": "6513512292", "contentTitle":"This is a test blog title", "userEmail":"tester@gmail.com", "userName":"tester" } Example POST response: { "id": 409700798, "portalId": 62515, "contentId": 6513512292, "contentTitle": "This is a test blog title", "contentPermalink": null, "collectionId": 6513512292, "createdAt": 1550599262439, "deletedAt": 0, "userName": "tester", "firstName": "tester", "lastName": "", "userEmail": "tester@gmail.com", "comment": "This is a test blog comment", "userUrl": "", "state": "PENDING_AKISMET", "userIp": "216.107.205.146", "userReferrer": "https://tools.hubteam.com/api/post/api.hubapi.com%2Fcomments%2Fv3%2Fcomments%3F?body=%7B%0A%22comment%22%3A%22This%20is%20a%20test%20blog%20comment%22%2C%0A%22contentId%22%3A%226513512292%22%2C%0A%22collectionId%22%3A%20%226513512292%22%2C%0", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.109 Safari/537.36", "contentAuthorEmail": null, "contentAuthorName": null, "contentCreatedAt": 0, "threadId": "0001.0000.0000.0000.0000.0000.0000.0000.0000.0000", "replyingTo": null, "parentId": 0, "legacyId": 0, "extraContext": null, "parent": null }