Update an interaction

patch

https://api.mindstamp.com/api/v1/interactions/{id}

Update an existing API-created annotation. Supports visible interaction annotations and timed action annotations created by POST /interactions/create. This uses the annotation ID returned by create.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The annotation ID for the interaction.

Query Params

type

string

enum

Annotation type. Visible types require layout and click action fields. Timed action types use their type-specific fields. Supported values: button, image, text, hotspot, redirect, jump, switch, pause, resourceTray, variable, reset_viewer, reset_interactions.

time

float

When the interaction should appear on the screen

finish

float

When a visible interaction should leave the screen. Optional for timed action annotations.

top

float

Visible interaction layout percentage persisted to pos_top. Required for button, image, text, and hotspot creates.

left

float

Visible interaction layout percentage persisted to pos_left. Required for button, image, text, and hotspot creates.

height

float

Visible interaction layout percentage persisted to pos_height. Required for button, image, text, and hotspot creates.

width

float

Visible interaction layout percentage persisted to pos_width. Required for button, image, text, and hotspot creates.

click_action

string

enum

Visible interaction click action. Required for button, image, text, and hotspot creates. Supported values: track, link, jump, video, back, message, view, genie, openai, clip, audio, email, phone, modal, collect, download, resourceTray, none. Timed action annotations choose the matching action automatically.

click_value

string

Action value. For redirect this can be the URL; for jump this can be the target timestamp; for switch this can be Video Title ---TOKEN.

content

string

A button text, text content, image source URL, or empty for hotspot

tooltip

string

pause_amount

integer

Pause duration in seconds for type=pause or visible interactions that pause on click. Use -1 to pause until the viewer resumes.

click_required

boolean

text_color

string

Visible interaction text color. Defaults to the video design when omitted.

background_color

string

Visible interaction background color. Defaults to the video design when omitted.

border_color

string

Visible interaction border color. Defaults to the video design when omitted.

border_radius

string

Visible interaction border radius. Defaults to the video design when omitted.

font_size

string

Visible interaction font size persisted to font_size.

redirect_url

string

Redirect destination URL for type=redirect. Alias for click_value on redirect annotations.

target_time

float

Target timestamp in seconds for type=jump. Alias for click_value on jump annotations.

target_video_id

string

Target video ID for type=switch. The API stores it as Video Title ---TOKEN in click_value.

target_video_token

string

Target video token for type=switch. The API stores it as Video Title ---TOKEN in click_value.

click_time

float

Start time in the target video for type=switch.

timer

integer

Pause duration in seconds for type=pause. Use -1 to pause until the viewer resumes. Alias for pause_amount.

variable

string

Variable name for type=variable.

value

string

Variable value for type=variable.

Responses

401

Not Authorized

404

Not Found

500

Error

503

Rate Limit Exceeded

200Success

422Unprocessable Entity