There's a new version of the HubSpot 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 Broadcast Message

Last updated May 31, 2023

POST /broadcast/v1/broadcasts

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Create a new broadcast message (e.g. a tweet or Facebook post) to be published. It can be scheduled immediately or at a time in the future.

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.
Channel GUID "channelGuid": {guid}
used in the request body
The GUID of the publishing channel that the message is for. You can get all of the channels for a portal using this endpoint.
Optional Parameters How to use Description
Trigger At "triggerAt": {timestamp}
used in the request body
A Unix timestamp in milliseconds of the time that the message should be published to the channel. If this is not included in the request, the message will be published immediately.
Create a draft message "status": "DRAFT"
used in the request body
Create the message as a draft, meaning that it will not be scheduled to publish and can be reviewed and scheduled from within the HubSpot Social Media Publishing app. Note: If the draft status is set, any triggerAt value will be unset.