v4

latestOpenAPI 3.0.3raw.githubusercontent.com2023-03-26273865.4 KB

Interactions

Create In-Page Experience Interaction

Creates an In-Page Experience Interaction

post/accounts/{{account_id}}/interactions

Request body

idstring

The id for the interaction

accountIdstring

The id of the account that the interaction interaction belongs to.

createdAtstring

A date-time string indicating when the interaction was created

updatedAtstring

A date-time string indicating when the interaction was last modified

type'Link' | 'Card' | 'External' required

The type of interaction

Link - A hyperlink
Card - A card that can contain text, a link, and/or an image
External - A custom type built with HTML, CSS, and JavaScript.

durationType'point' | 'span' | 'end' | 'full'

Duration type of the interaction

point - it appears at some point in playback
span - it is available over some span of playback
end - it is available at the end of playback
full - it is always available There is no need to set durationType if you are setting start and end. It will simply reflect what you set there. For durationType set to end or full only, you can use this as a shortcut instead of setting start and end.

experiencestring

An experience id. If specified when you create an interaction, the interaction will belong to that experience. If you do not specify an experience, the interaction can be used by any experience.

placement'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'

Physical placement of a Link interaction. Used only for 'Link' tupes interactions

textstring

Link text for a hyperlink. Used for Link and Card type interactions.

hrefstring

The URL that a hyperlink points to. Used for Link and Card type interactions.

titlestring

The title for a card. Used forCard type interactions.

descriptionstring

The description for a card. Used forCard type interactions.

imgstring

A URL pointing to the image for a card. Used forCard type interactions.

Example request

{
  "createdAt": "2019-03-13T17:47:37.077Z",
  "updatedAt": "2019-03-13T17:47:37.077Z",
  "experience": "5bc4991f0f6f340011b3e968"
}

Response

CREATED