Skip to main content
POST
Create a played event

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
Available options:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
required
sessionId
string
required
state
enum<string>
required
Available options:
STARTED,
VIEWED
_hsenc
string
contactId
integer<int64>
contactUtk
string
externalId
string
externalPlayContext
enum<string>
Available options:
EMAIL,
EXTERNAL_PAGE
iframeUrl
string
mediaBridgeId
integer<int64>
mediaName
string
mediaUrl
string
pageId
integer<int64>
pageName
string
pageUrl
string

Response

successful operation

contactId
integer<int64>
required
mediaBridgeId
integer<int64>
required
mediaBridgeObjectCoordinates
string
required
mediaBridgeObjectTypeId
string
required
mediaName
string
required
mediaType
enum<string>
required
Available options:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
required
portalId
integer<int32>
required
providerId
integer<int32>
required
sessionId
string
required
state
enum<string>
required
Available options:
STARTED,
VIEWED
externalPlayContext
enum<string>
Available options:
EMAIL,
EXTERNAL_PAGE
iframeUrl
string
mediaUrl
string
pageId
integer<int64>
pageName
string
pageObjectCoordinates
string
pageUrl
string
Last modified on April 13, 2026