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.

Get a Broadcast Message

Last updated May 15, 2023

GET /broadcast/v1/broadcasts/:broadcast_guid

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

social

For a given HubID, return details on a specific broadcast (e.g. a tweet or Facebook post).

A "broadcast" is a specific social message posted to a single social network.

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.
broadcast_guid Used in the request URL Unique identifier for a specific broadcast.
Optional Parameters How to use Description
None None No optional parameters for this method.

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 URL requesting JSON: https://api.hubapi.com/broadcast/v1/broadcasts/65cc83ae-f962-452d-8d70-20cbd3204e61?portalId=62515 Example JSON output. Note the "status" field indicates the state of the message, where it could be "WAITING" if it is scheduled to be published later, "SUCCESS" for successfully published or "ERROR_FATAL" if there was an error publishing the message. { "broadcastGuid": "4745142", "portalId": 62515, "groupGuid": "9e714a24-4973-452b-8622-cfd2e072b0cf", "campaignGuid": null, "channelKey": "Twitter:403551555", "channelGuid": "cd0bccfc-390d-3840-aa77-d413b253c807", "clientTag": "SocialUI_clone", "createdAt": 1553275615529, "userUpdatedAt": 1554967001342, "triggerAt": 1563386460000, "finishedAt": null, "status": "DRAFT", "message": null, "content": { "originalLink": null, "charCount": "22", "originalBody": "test test a video post", "uncompressedLinks": null, "hashtagCount": "0", "body": "test test a video post", "title": "test test a video post", "thumbUrl": "https://cdn2.hubspot.com/hubfs/62515/social-suggested-images/2019-video.mp4/thumb.jpg", "fileId": "3385520023" }, "foreignId": null, "remoteContentId": null, "remoteContentType": null, "clicks": 0, /* NOTE: The following fields are deprecated, and will always be set to null "messageUrl": null, "taskQueueId": null, // "linkGuid": null, // "linkTaskQueueId": null, // // NOTE: The following fields are deprecated, and will always be set to 0 "replies": 0, // "retweets": 0, // "likes": 0, // "interactionsCount": 0, */ "createdBy": 546233, "updatedBy": 546233, "campaignName": null, "broadcastMediaType": "VIDEO", "wasDraft": true, "channel": null, "serviceId": null, "extraData": { "files": [ { "url": "https://cdn2.hubspot.com/hubfs/62515/social-suggested-images/2019-video.mp4", "mediaType": "VIDEO", "height": 300, "width": 600, "description": null, "id": 3385520023 } ], "body": "test test a video post", "updatedClientTag": "SocialUI_composer" }, "isPending": false, "isPublished": false, "isFailed": false, "isRetry": false, "messageText": "test test a video post" }