Cancel a Broadcast Message

Last updated June 17, 2020

DELETE /broadcast/v1/broadcasts/:broadcast_guid

Method Details

HTTP Methods:

DELETE

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Cancel a scheduled broadcast (e.g. tweet or facebook post).

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.
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?hapikey=demo Example JSON output. The modified broadcast will be return. If the broadcast was already completed, its status will not be changed. { "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" }, "messageUrl": null, "foreignId": null, "remoteContentId": null, "remoteContentType": null, "clicks": 0, /* NOTE: The following fields are deprecated, and will always be set to 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" }