Skip to main content
POST
Record Media Played Percentage

Supported products

Authorizations

Authorization
string
header
required

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

Body

application/json
mediaType
enum<string>
required

The type of media that was played. Valid values include 'VIDEO', 'AUDIO', 'DOCUMENT', 'OTHER', and 'IMAGE'.

Available options:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
required

The timestamp when the media play event occurred.

playedPercent
integer<int32>
required

The percentage of the media that has been played.

sessionId
string
required

The unique identifier for the session in which the media was played.

_hsenc
string

HubSpot encoding parameter for tracking purposes.

contactId
integer<int64>

The unique identifier for the contact associated with the media play event.

contactUtk
string

The user token key associated with the contact.

externalId
string

An external identifier for the media, provided by the user.

externalPlayContext
enum<string>

Additional context provided externally about the media play event.

Available options:
EMAIL,
EXTERNAL_PAGE
mediaBridgeId
integer<int64>

The unique identifier for the media bridge instance.

mediaName
string

The name of the media that was played.

mediaUrl
string

The URL where the media is hosted.

pageId
integer<int64>

The unique identifier for the page where the media was played.

pageName
string

The name of the page where the media was played.

pageUrl
string

The URL of the page where the media was played.

Response

successful operation

contactId
integer<int64>
required

The unique identifier for the contact associated with the media event. It is a string value.

mediaBridgeId
integer<int64>
required

The unique identifier for the media bridge instance. It is a string value.

mediaBridgeObjectCoordinates
string
required

Coordinates that specify the location of the media bridge object. It is a string value.

mediaBridgeObjectTypeId
string
required

The type identifier for the media bridge object. It is a string value.

mediaName
string
required

The name of the media content being played. It is a string value.

mediaType
enum<string>
required

The type of media being played, such as 'VIDEO', 'AUDIO', etc. It is a string value.

Available options:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
required

The timestamp when the media play event occurred. It is a string value in ISO 8601 format.

playedPercent
integer<int32>
required

The percentage of the media content that has been played. It is a number value.

portalId
integer<int32>
required

The unique identifier for the HubSpot portal. It is an integer value.

providerId
integer<int32>
required

The unique identifier for the media provider. It is a string value.

sessionId
string
required

The unique identifier for the session during which the media was played. It is a string value.

externalPlayContext
enum<string>

Contextual information about the external environment where the media is played. It is a string value.

Available options:
EMAIL,
EXTERNAL_PAGE
mediaUrl
string

The URL of the media content being played. It is a string value.

pageId
integer<int64>

The unique identifier for the page where the media is being played. It is a string value.

pageName
string

The name of the page where the media is being played. It is a string value.

pageObjectCoordinates
string

Coordinates that specify the location of the page object. It is a string value.

pageUrl
string

The URL of the page where the media is being played. It is a string value.

Last modified on September 9, 2026