Update video settings

patch

https://api.mindstamp.com/api/v1/videos/{id}/settings

Change fields on the Settings page of a video. Send a JSON body with only the fields to change. The response contains all settings. Design fields, such as guide_transcript, use Update video design.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Video ID or token.

Body Params

title

string

Video title. It must not be empty.

url_title

string | null

Custom share URL path, as in https://share.mindstamp.com/w/{url_title}. It must be unique.

tab_title

string | null

Browser tab title. Empty uses the video title.

message

string | null

Share message.

message_position

string

enum

Where the share message shows on the video.

Allowed:

tags

group_id

string | null

Group ID in your organization. null removes the group.

folder_id

string | null

Folder ID in your organization. The folder must be in the video's group. null removes the folder.

privacy

integer

enum

0 anyone with the link, 2 password, 3 access list.

Allowed:

password

array of strings

Viewer passwords. Replaces the current list. Privacy 2 needs at least one.

password

access_list_id

string | null

Access list ID in your organization. Privacy 3 needs one.

participate

boolean

Allow viewers to add comments.

organization_access

boolean

Organization members can view. false also sets organization_edit to false.

organization_edit

boolean

Organization members can edit. This needs organization_access.

showTitle

boolean

Show the title on the video.

showMessage

boolean

Show the share message on the video.

show_branding

boolean

Show the play icon before the video starts.

is_resumable

boolean

Returning viewers continue where they stopped.

can_skip_clips

boolean

Allow skipping of video and audio clips.

skip_amount

integer | null

Seconds that the skip buttons jump. Must be greater than 0.

block_pausing

boolean

Prevent pausing.

pause_inactive

boolean

Pause when the browser tab is inactive.

resume_focus

boolean

Resume when the browser tab is active again.

pause_for_guide

boolean

Pause while the Video Guide is open.

tab_links

boolean

Open links in a new tab.

auto_enable_captions_on_language_change

boolean

Show captions when the viewer changes the language.

use_chapter_timing

boolean

Use the chapter timing display.

show_interactions_during_questions

boolean

Show other interactions while a question is open.

prevent_passing_required_interactions

boolean

Viewers cannot seek past required interactions.

use_afk

boolean

Ask the viewer at intervals to confirm that they are present.

afk_amount

integer

Seconds between attention checks. Must be greater than 0.

start_volume

integer

0 to 100

Start volume in percent, 0 to 100. A volume URL parameter overrides it.

audio_mode

string

enum

video plays the audio of the video. custom plays the custom_audio_id file.

Allowed:

custom_audio_id

string | null

ID of an MP3, M4A, or AAC audio file in your organization.

speak_genie

boolean

Speak Genie answers aloud.

speak_messages

boolean

Speak messages aloud.

genie_voice_number

integer

0 to 12

Voice for spoken answers and messages, 0 to 12.

embed_only

boolean

The video plays only when embedded on your site.

include_query_params

boolean

Add variables to links that viewers open.

collect_geolocation

boolean

Collect the precise location of the viewer.

force_mp4

boolean

Full-quality streaming. Only uploaded MP4 files can use it. true clears force_quality.

force_quality

string | null

A fixed streaming quality that the video has, such as 720p. null means automatic.

Responses

401

Not Authorized

200Success

404Not Found

422A value is not valid. The message gives the reason.