Create broadcast (Deprecated)

Create a broadcast message

curl --request POST \
  --url https://api.hubapi.com/broadcast/v1/broadcasts/{broadcast_guid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channelGuid": "<string>",
  "triggerAt": 123,
  "status": "<string>"
}
'

{
  "broadcastGuid": "<string>",
  "portalId": 123,
  "groupGuid": "<string>",
  "campaignGuid": "<string>",
  "channelKey": "<string>",
  "channelGuid": "<string>",
  "clientTag": "<string>",
  "createdAt": 123,
  "userUpdatedAt": 123,
  "triggerAt": 123,
  "finishedAt": 123,
  "status": "<string>",
  "message": "<string>",
  "content": {},
  "foreignId": 123,
  "remoteContentId": 123,
  "remoteContentType": "<string>",
  "clicks": 123,
  "createdBy": 123,
  "updatedBy": 123,
  "campaignName": "<string>",
  "broadcastMediaType": "<string>",
  "wasDraft": true,
  "channel": "<string>",
  "serviceId": 123,
  "extraData": {},
  "isPending": true,
  "isPublished": true,
  "isFailed": true,
  "isRetry": true,
  "messageText": "<string>"
}

POST

broadcast

broadcasts

{broadcast_guid}

Create a broadcast message

curl --request POST \
  --url https://api.hubapi.com/broadcast/v1/broadcasts/{broadcast_guid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channelGuid": "<string>",
  "triggerAt": 123,
  "status": "<string>"
}
'

{
  "broadcastGuid": "<string>",
  "portalId": 123,
  "groupGuid": "<string>",
  "campaignGuid": "<string>",
  "channelKey": "<string>",
  "channelGuid": "<string>",
  "clientTag": "<string>",
  "createdAt": 123,
  "userUpdatedAt": 123,
  "triggerAt": 123,
  "finishedAt": 123,
  "status": "<string>",
  "message": "<string>",
  "content": {},
  "foreignId": 123,
  "remoteContentId": 123,
  "remoteContentType": "<string>",
  "clicks": 123,
  "createdBy": 123,
  "updatedBy": 123,
  "campaignName": "<string>",
  "broadcastMediaType": "<string>",
  "wasDraft": true,
  "channel": "<string>",
  "serviceId": 123,
  "extraData": {},
  "isPending": true,
  "isPublished": true,
  "isFailed": true,
  "isRetry": true,
  "messageText": "<string>"
}

Please note: the social media API is deprecated. While previous functionality is supported in a limited capacity, you should not use this API if you’re building a new app.

Required Scopes

This API requires one of the following scopes:

social

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request body for broadcast

channelGuid

string

required

The GUID of the publishing channel that the message is for. You can get the GUID of the channel by using the GET request at the top of this article.

triggerAt

integer<int32>

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.

status

string

Use 'status': 'DRAFT' in the request body. This creates 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. If the draft status is set, any triggerAt value will be unset.

Response

Successful operation

broadcastGuid

string

Unique identifier for the broadcast provided by the social network

portalId

integer<int32>

ID of the HubSpot account

groupGuid

string

Unique identifier for the parent entity of the broadcast (e.g., a Facebook page ID)

campaignGuid

string

ID of an associated HubSpot campaign

channelKey

string

A key that concatenates the network with the channelId

channelGuid

string

Unique identifier for the channel provided by the social network

clientTag

string

An internal identifier for HubSpot's integration

createdAt

integer<int32>

Timestamp for when the broadcast was created

userUpdatedAt

integer<int32>

A unix timestamp in milliseconds that corresponds to when the user last updated the broadcast

triggerAt

integer<int32>

A unix timestamp in milliseconds that corresponds to a scheduled time to publish the broadcast

finishedAt

integer<int32>

A unix timestamp in milliseconds when the post was successfully published

status

string

The status of the broadcast (e.g., 'DRAFT')

message

string

An optional field included in the broadcasts of certain social networks.

content

object

The content of your broadcast, the properties for which varies by network.

foreignId

integer<int32>

An internal identifier for the broadcast.

remoteContentId

integer<int32>

An internal identifier for the broadcast.

remoteContentType

string

An internal type of the broadcast.

clicks

integer<int32>

The number clicks the broadcast has received

createdBy

integer<int32>

The ID of the HubSpot user who created the broadcast

updatedBy

integer<int32>

The ID of the HubSpot user who last updated the broadcast

campaignName

string

The name of the associated HubSpot campaign, if applicable

broadcastMediaType

string

The format of the broadcast (e.g., 'VIDEO')

wasDraft

boolean

Whether the broadcast was previously in a drafted state before officially posting to the network.

channel

string

An internal identifier used by HubSpot.

serviceId

integer<int32>

An internal identifier used by HubSpot.

extraData

object

An object with additional data included with the broadcast, including any files, broadcast body text, and an internal client tag used by HubSpot.

isPending

boolean

An internal field used to identify whether the broadcast is still pending.

isPublished

boolean

An internal field used to identify whether the broadcast was successfully published.

isFailed

boolean

An internal field used to identify whether the broadcast failed to be posted to the network.

isRetry

boolean

An internal field used to identify whether the broadcast had to be retried.

messageText

string

Inner text body of the broadcast

​Required Scopes

Authorizations

Body

Response

Required Scopes