Create an interaction

post https://api.mindstamp.com/api/v1/interactions/create

Create a new button, image, hotspot, or text interaction for a specified video

Query Params

video_id

string

required

The video_id or token of the video you want to add the interaction to.

type

string

required

The type of interaction (either 'button', 'image', 'text', or 'hotspot')

time

string

required

When the interaction should appear on the screen

finish

string

required

When the interaction should leave the screen

top

string

required

left

string

required

height

string

required

width

string

required

click_action

string

required

What the interaction does when clicked (either 'track', 'link', 'jump', 'video', 'back', 'message', 'view', 'genie', 'cart', 'openai', 'clip', 'audio', 'email', 'phone', 'modal', 'collect', 'download', 'resourceTray', 'show_card', 'get', 'post', or 'none')

click_value

string

The value associated with the click_action

content

string

A button's text, a text's content, an image source URL, or empty for hotspot

pause_amount

string

click_required

string

text_color

string

background_color

string

font_size

string

Responses

401

Not Authorized

404

Not Found

422

Unprocessable Entity

500

Error

503

Rate Limit Exceeded

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.mindstamp.com/api/v1/interactions/create \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200Success