Sign in

v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Advanced

Create a played event

Create an event for when a user begins playing a piece of media.

post/media-bridge/2026-03/events/media-played

Request body

_hsencstring
contactIdinteger
contactUtkstring
externalIdstring
externalPlayContext'EMAIL' | 'EXTERNAL_PAGE'
iframeUrlstring
mediaBridgeIdinteger
mediaNamestring
mediaType'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO' required
mediaUrlstring
occurredTimestampinteger required
pageIdinteger
pageNamestring
pageUrlstring
sessionIdstring required
state'STARTED' | 'VIEWED' required

Response

successful operation

contactIdinteger required
externalPlayContext'EMAIL' | 'EXTERNAL_PAGE'
iframeUrlstring
mediaBridgeIdinteger required
mediaBridgeObjectCoordinatesstring required
mediaBridgeObjectTypeIdstring required
mediaNamestring required
mediaType'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO' required
mediaUrlstring
occurredTimestampinteger required
pageIdinteger
pageNamestring
pageObjectCoordinatesstring
pageUrlstring
portalIdinteger required
providerIdinteger required
sessionIdstring required
state'STARTED' | 'VIEWED' required