VideosAnimatedThumbnailsGetAllSetsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/animated-thumbset"
}
}
VideosChaptersGenerateChapterThumbnailOrUploadLinkRequest
{
"type": "object",
"properties": {
"timecode": {
"type": "number",
"example": 140,
"description": "The timecode, given in seconds from the start of the video, indicating when the thumbnail should be generated from the video."
}
}
}
VideosChaptersGenerateChapterThumbnailRequest
{
"type": "object",
"properties": {
"timecode": {
"type": "number",
"example": 140,
"description": "The timecode, given in seconds from the start of the video, indicating when the thumbnail should be generated from the video."
}
}
}
VideosChaptersSetChapterThumbnailActiveRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether to set the chapter thumbnail as active."
}
}
}
VideosContentRatingsGetAllContentRatingsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/content-rating"
}
}
VideosCreativeCommonsGetAllCcLicensesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/creative-commons"
}
}
VideosCreditsAddUserCreditInVideoRequest
{
"type": "object",
"required": [
"email",
"name",
"role",
"user_uri"
],
"properties": {
"name": {
"type": "string",
"example": "Sam Doe",
"description": "The name of the credited person."
},
"role": {
"type": "string",
"example": "Producer",
"description": "The role of the credited person."
},
"email": {
"type": "string",
"example": "user@example.com",
"description": "The email address of the credited person."
},
"user_uri": {
"type": "string",
"example": "/users/152184",
"description": "The Vimeo URI of the credited person."
}
}
}
VideosCreditsAddUserCreditRequest
{
"type": "object",
"required": [
"email",
"name",
"role",
"user_uri"
],
"properties": {
"name": {
"type": "string",
"example": "Sam Doe",
"description": "The name of the credited person."
},
"role": {
"type": "string",
"example": "Producer",
"description": "The role of the credited person."
},
"email": {
"type": "string",
"example": "user@example.com",
"description": "The email address of the credited person."
},
"user_uri": {
"type": "string",
"example": "/users/152184",
"description": "The Vimeo URI of the credited person."
}
}
}
VideosCreditsEditUserCreditInVideoRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Sam Doe",
"description": "The name of the credited person."
},
"role": {
"type": "string",
"example": "Producer",
"description": "The role of the credited person."
}
}
}
VideosCreditsGetAllCreditedUsersInVideo200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/credit"
}
}
VideosCreditsGetAllCreditedUsersInVideoResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/credit"
}
}
VideosEmbedPrivacyListWhitelistDomainsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/domain"
}
}
VideosEssentialsGetAllUserVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
VideosEssentialsGetUserAppearancesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
VideosRecommendationsGetRelatedVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
VideosShowcasesAddToMultipleShowcasesRequest
{
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "The showcase URI to add the video to."
}
}
},
"description": "The array of showcases to add the video to. Specify these with a batch request; see our [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests) guide for more information."
},
"remove": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "The showcase URI to remove the video from."
}
}
},
"description": "The array of showcases to remove the video from. Specify these with a batch request; see our [Using Common Formats and Parameters](https://developer.vimeo.com/api/common-formats#working-with-batch-requests) guide for more information."
}
}
}
VideosShowcasesAddToMultipleShowcasesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/album"
}
}
VideosShowcasesGetAllContShowcasesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/album"
}
}
VideosTagsAddMultipleResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/tag"
}
}
VideosTagsGetAllByTagResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
VideosTagsGetVideoTagsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/tag"
}
}
VideosTextTracksAddTextTrackRequest
{
"type": "object",
"required": [
"language",
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"example": "Commentary",
"description": "The name of the text track."
},
"type": {
"enum": [
"captions",
"chapters",
"descriptions",
"metadata",
"subtitles"
],
"type": "string",
"description": "The type of text track.\n\nOption descriptions:\n * `captions` - The text track is the captions type.\n * `chapters` - The text track is the chapters type.\n * `descriptions` - The text track is the descriptions type.\n * `metadata` - The text track is the metadata type.\n * `subtitles` - The text track is the subtitles type.\n"
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the current text track is the *active text track,* or the one that appears in the player. Only one text track per language and type can be active."
},
"language": {
"type": "string",
"example": "en-US",
"description": "The language of the text track. For a full list of supported languages, use the [`/languages?filter=texttracks`](https://developer.vimeo.com/api/reference/videos#get_languages) endpoint."
},
"is_edited": {
"type": "boolean",
"description": "Whether the text track was uploaded by the Seshat audio annotation management platform after the user edited their transcript."
},
"is_auto_generated": {
"type": "boolean",
"description": "Whether the text track was uploaded automatically by the Seshat audio annotation management platform."
}
}
}
VideosTextTracksAddTextTrackToVideoRequest
{
"type": "object",
"required": [
"language",
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"example": "Commentary",
"description": "The name of the text track."
},
"type": {
"enum": [
"captions",
"chapters",
"descriptions",
"metadata",
"subtitles"
],
"type": "string",
"description": "The type of text track.\n\nOption descriptions:\n * `captions` - The text track is the captions type.\n * `chapters` - The text track is the chapters type.\n * `descriptions` - The text track is the descriptions type.\n * `metadata` - The text track is the metadata type.\n * `subtitles` - The text track is the subtitles type.\n"
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the current text track is the *active text track,* or the one that appears in the player. Only one text track per language and type can be active."
},
"language": {
"type": "string",
"example": "en-US",
"description": "The language of the text track. For a full list of supported languages, use the [`/languages?filter=texttracks`](https://developer.vimeo.com/api/reference/videos#get_languages) endpoint."
},
"is_edited": {
"type": "boolean",
"description": "Whether the text track was uploaded by the Seshat audio annotation management platform after the user edited their transcript."
},
"is_auto_generated": {
"type": "boolean",
"description": "Whether the text track was uploaded automatically by the Seshat audio annotation management platform."
}
}
}
VideosTextTracksEditTextTrackRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Commentary",
"description": "The name of the text track."
},
"type": {
"enum": [
"captions",
"chapters",
"descriptions",
"metadata",
"subtitles"
],
"type": "string",
"description": "The type of text track.\n\nOption descriptions:\n * `captions` - The text track is the captions type.\n * `chapters` - The text track is the chapters type.\n * `descriptions` - The text track is the descriptions type.\n * `metadata` - The text track is the metadata type.\n * `subtitles` - The text track is the subtitles type.\n"
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the current text track is the *active text track,* or the one that appears in the player. Only one text track per language and per type can be active."
},
"language": {
"type": "string",
"example": "en-US",
"description": "The language of the text track. For a full list of supported languages, use the [`/languages?filter=texttracks`](https://developer.vimeo.com/api/reference/videos#get_languages) endpoint."
}
}
}
VideosTextTracksGetAllTracksResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/text-track"
}
}
VideosTextTracksGetAllVideoTracksResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/text-track"
}
}
VideosThumbnailsAddThumbnailToVideoRequest
{
"type": "object",
"properties": {
"time": {
"type": "number",
"example": 300,
"description": "The time offset in seconds from which to create the thumbnail."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the image created by the **time** field should be the default thumbnail for the video."
}
}
}
VideosThumbnailsAddThumbnailToVideoRequest1
{
"type": "object",
"properties": {
"time": {
"type": "number",
"example": 300,
"description": "The time offset in seconds from which to create the thumbnail."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the image created by the **time** field should be the default thumbnail for the video."
}
}
}
VideosThumbnailsEditThumbnailImageRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether this thumbnail is the default."
}
}
}
VideosThumbnailsGetAllByVideoId200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
VideosThumbnailsGetAllByVideoIdResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
VideosUnlistedVideosGrantAccessToUsers200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
VideosUnlistedVideosGrantAccessToUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
VideosUnlistedVideosListAccessibleUsers200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
VideosUnlistedVideosListAccessibleUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
VideosUploadsBeginVideoUploadProcessRequest
{
"type": "object",
"required": [
"upload"
],
"properties": {
"name": {
"type": "string",
"example": "Celebrating 10 Years of Staff Picks",
"description": "The title of the video."
},
"embed": {
"type": "object",
"properties": {
"color": {
"type": "string",
"example": "#1ab7ea",
"description": "The main color of the embeddable player."
},
"logos": {
"type": "object",
"properties": {
"vimeo": {
"type": "boolean",
"example": true,
"description": "Whether to show the Vimeo logo on the embeddable player."
},
"custom": {
"type": "object",
"properties": {
"link": {
"type": "string",
"example": "https://example.com",
"description": "The URL that loads when the user clicks the custom logo."
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether to show the active custom logo on the embeddable player."
},
"sticky": {
"type": "boolean",
"example": true,
"description": "Whether the custom logo is always visible on the embeddable player (`true`) or whether the logo appears and disappears with the rest of the UI (`false`)."
}
}
}
}
},
"title": {
"type": "object",
"properties": {
"name": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"description": "How to handle the video title in the title bar of the embeddable player.\n\nOption descriptions:\n * `hide` - Hide the video title.\n * `show` - Show the video title.\n * `user` - Enable the user to decide.\n"
},
"owner": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"description": "How to handle the owner information in the title bar of the embeddable player.\n\nOption descriptions:\n * `hide` - Hide the owner info.\n * `show` - Show the owner info.\n * `user` - Enable the user to decide.\n"
},
"portrait": {
"enum": [
"hide",
"show",
"user"
],
"type": "string",
"description": "How to handle the owner portrait in the title bar of the embeddable player.\n\nOption descriptions:\n * `hide` - Hide the portrait.\n * `show` - Show the portrait.\n * `user` - Enable the user to decide.\n"
}
}
},
"volume": {
"type": "boolean",
"example": true,
"description": "Whether to show the volume selector on the embeddable player."
},
"buttons": {
"type": "object",
"properties": {
"hd": {
"type": "boolean",
"example": true,
"description": "Whether to show the `HD` button on the embeddable player."
},
"like": {
"type": "boolean",
"example": true,
"description": "Whether to show the `like` button on the embeddable player."
},
"embed": {
"type": "boolean",
"example": true,
"description": "Whether to show the `embed` button on the embeddable player."
},
"share": {
"type": "boolean",
"example": true,
"description": "Whether to show the `share` button on the embeddable player."
},
"scaling": {
"type": "boolean",
"example": true,
"description": "Whether to show the `scaling` button on the embeddable player in fullscreen mode."
},
"fullscreen": {
"type": "boolean",
"example": true,
"description": "Whether to show the `fullscreen` button on the embeddable player."
},
"watchlater": {
"type": "boolean",
"example": true,
"description": "Whether to show the `watch later` button on the embeddable player."
}
}
},
"playbar": {
"type": "boolean",
"example": true,
"description": "Whether to show the playbar on the embeddable player."
},
"end_screen": {
"type": "object",
"properties": {
"type": {
"enum": [
"empty",
"loop",
"share",
"thumbnail"
],
"type": "string",
"description": "The end screen type.\n\nOption descriptions:\n * `empty` - The end screen is empty.\n * `loop` - The end screen loops the video playback.\n * `share` - The end screen includes sharing options.\n * `thumbnail` - The end screen includes the thumbnail of the video.\n"
}
}
}
}
},
"locale": {
"type": "string",
"example": "en_US",
"description": "The video's default language. For a full list of supported languages, use the [`/languages?filter=texttracks`](https://developer.vimeo.com/api/reference/videos#get_languages) endpoint."
},
"upload": {
"type": "object",
"required": [
"approach"
],
"properties": {
"link": {
"type": "string",
"example": "https://example.com/video.mp4",
"description": "The public URL at which the video is hosted. The URL must be valid for at least 24 hours. Use this parameter when **approach** is `pull`."
},
"size": {
"type": "string",
"example": "13623861",
"description": "The size in bytes of the video to upload. The maximum value of this field is `268435456000`, which corresponds to 250 GB."
},
"approach": {
"enum": [
"post",
"pull",
"tus"
],
"type": "string",
"description": "The upload approach.\n\nOption descriptions:\n * `post` - Use the `post` approach.\n * `pull` - Use the `pull` approach.\n * `tus` - Use the `tus` approach.\n"
},
"redirect_url": {
"type": "string",
"example": "https://example.com",
"description": "The app's redirect URL. Use this parameter when **approach** is `post`."
}
}
},
"license": {
"enum": [
"by",
"by-nc",
"by-nc-nd",
"by-nc-sa",
"by-nd",
"by-sa",
"cc0"
],
"type": "string",
"description": "The Creative Commons license under which the video is offered.\n\nOption descriptions:\n * `by` - The video is offered under CC BY, or the attibution-only license.\n * `by-nc` - The video is offered under CC BY-NC, or the Attribution-NonCommercial license.\n * `by-nc-nd` - The video is offered under CC BY-NC-ND, or the Attribution-NonCommercian-NoDerivs license.\n * `by-nc-sa` - The video is offered under CC BY-NC-SA, or the Attribution-NonCommercial-ShareAlike licence.\n * `by-nd` - The video is offered under CC BY-ND, or the Attribution-NoDerivs license.\n * `by-sa` - The video is offered under CC BY-SA, or the Attribution-ShareAlike license.\n * `cc0` - The video is offered under CC0, or the public domain license.\n"
},
"privacy": {
"type": "object",
"properties": {
"add": {
"type": "boolean",
"example": true,
"description": "Whether a user can add the video to a showcase, channel, or group."
},
"view": {
"enum": [
"anybody",
"contacts",
"disable",
"nobody",
"password",
"unlisted",
"users"
],
"type": "string",
"description": "The video's privacy setting. When this value is `users`, `application/json` is the only valid content type. Also, some privacy settings are unavailable to Vimeo Free members; for more information, see our [Help Center](https://vimeo.zendesk.com/hc/en-us/articles/224817847).\n\nOption descriptions:\n * `anybody` - Anyone can access the video. This privacy setting appears as `Public` on the Vimeo front end.\n * `contacts` - Only those who follow the owner on Vimeo can access the video. _This field is deprecated._\n * `disable` - The video is embeddable, but it's hidden on Vimeo and can't be played. This privacy setting appears as `Hide from Vimeo` on the Vimeo front end. _This field is deprecated._\n * `nobody` - No one except the owner can access the video. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the video.\n * `unlisted` - Only those with the private link can access the video.\n * `users` - Only Vimeo members can access the video. _This field is deprecated._\n"
},
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"description": "The video's embed setting. Specify the `whitelist` value to restrict embedding to a specific set of domains. For more information, see our [Interacting with Videos](https://developer.vimeo.com/api/guides/videos/interact#set-off-site-privacy) guide.\n\nOption descriptions:\n * `private` - The video can't be embedded.\n * `public` - The video can be embedded.\n * `whitelist` - The video can be embedded on the specified domains only.\n"
},
"comments": {
"enum": [
"anybody",
"contacts",
"nobody"
],
"type": "string",
"description": "The privacy level required to comment on the video.\n\nOption descriptions:\n * `anybody` - Anyone can comment on the video.\n * `contacts` - Only the video owner's contacts can comment on the video.\n * `nobody` - No one can comment on the video.\n"
},
"download": {
"type": "boolean",
"example": true,
"description": "Whether a user can download the video. This field isn't available to Vimeo Free members."
}
}
},
"spatial": {
"type": "object",
"properties": {
"projection": {
"enum": [
"cubical",
"cylindrical",
"dome",
"equirectangular",
"pyramid"
],
"type": "string",
"description": "The 360 spatial projection.\n\nOption descriptions:\n * `cubical` - Use cubical projection.\n * `cylindrical` - Use cylindrical projection.\n * `dome` - Use dome projection.\n * `equirectangular` - Use equirectangular projection.\n * `pyramid` - Use pyramid projection.\n"
},
"field_of_view": {
"type": "number",
"example": 50,
"description": "The 360 field of view. This value must be between `30` and `90`; the default value is `50`."
},
"stereo_format": {
"enum": [
"left-right",
"mono",
"top-bottom"
],
"type": "string",
"description": "The 360 spatial stereo format.\n\nOption descriptions:\n * `left-right` - Use left-right stereo.\n * `mono` - Use monaural audio.\n * `top-bottom` - Use top-bottom stereo.\n"
},
"director_timeline": {
"type": "array",
"items": {
"type": "object",
"required": [
"pitch",
"time_code",
"yaw"
],
"properties": {
"yaw": {
"type": "number",
"example": 125,
"description": "The 360 director timeline yaw. This value must be between `0` and `360`, and it's required only when **spatial.director_timeline** is defined."
},
"roll": {
"type": "number",
"description": "The 360 director timeline roll."
},
"pitch": {
"type": "number",
"example": 70,
"description": "The 360 director timeline pitch. This value must be between `−90` and `90`, and it's required only when **spatial.director_timeline** is defined."
},
"time_code": {
"type": "number",
"example": 5,
"description": "The 360 director timeline time code. This field is required only when **spatial.director_timeline** is defined."
}
}
},
"description": "An array representing the 360 director timeline."
}
}
},
"password": {
"type": "string",
"example": "hunter1",
"description": "The password. This field is required when **privacy.view** is `password`."
},
"folder_uri": {
"type": "string",
"example": "/users/12345/folders/6789",
"description": "The URI of the folder to which the video is uploaded."
},
"description": {
"type": "string",
"example": "A celebration of 10 years of Staff Picks.",
"description": "The description of the video."
},
"review_page": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether to enable video review."
}
}
},
"embed_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "The complete list of domains the video can be embedded on. This field requires that **privacy_embed** have the value `whitelist`."
},
"content_rating": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values describing the content in this video. For a full list of values, use the [`/contentratings`](https://developer.vimeo.com/api/reference/videos#get_content_ratings) endpoint."
},
"hide_from_vimeo": {
"type": "boolean",
"example": false,
"description": "Whether to hide the video from everyone except the video's owner. When the value is `true`, unlisted video links work only for the video's owner."
}
}
}
VideosVersionsAddVideoVersionRequest
{
"type": "object",
"required": [
"file_name",
"upload"
],
"properties": {
"upload": {
"type": "object",
"required": [
"approach"
],
"properties": {
"link": {
"type": "string",
"example": "https://example.com",
"description": "The public URL from which to download the version when **upload.approach** is `pull`. This URL must be valid for at least 24 hours."
},
"size": {
"type": "string",
"example": "13623861",
"description": "The upload size of the version."
},
"approach": {
"enum": [
"post",
"pull",
"tus"
],
"type": "string",
"description": "The approach by which to upload the version.\n\nOption descriptions:\n * `post` - Use the `post` method.\n * `pull` - Use the `pull` method.\n * `tus` - Use the `tus` method.\n"
},
"redirect_url": {
"type": "string",
"example": "https://example.com",
"description": "The app's redirect URL when **upload.approach** is `post`."
}
}
},
"file_name": {
"type": "string",
"example": "untitled.mp4",
"description": "The name of the version."
}
}
}
VideosVersionsEditVideoVersionRequest
{
"type": "object",
"properties": {
"is_current": {
"type": "boolean",
"example": true,
"description": "Whether the video version is active."
},
"description": {
"type": "string",
"example": "description with emoji",
"description": "A description of the video version. This description can make use of the full unicode character set."
}
}
}
VideosVersionsGetAllVideoVersions200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video-version"
}
}
VideosVersionsGetAllVideoVersionsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video-version"
}
}
VideosVideoCommentsAddNewCommentRequest
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"example": "I love this!",
"description": "The text of the comment."
}
}
}
VideosVideoCommentsCreateReplyRequest
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"example": "I love this!",
"description": "The reply to the comment."
}
}
}
VideosVideoCommentsGetAllReplies200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/comment"
}
}
VideosVideoCommentsGetAllRepliesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/comment"
}
}
WatchLaterQueueEssentialsGetVideosInQueueResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
WatchLaterQueueEssentialsListUserQueueVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
WebinarEmailsCustomizePreferencesRequest
{
"type": "object",
"properties": {
"from": {
"type": "string",
"example": "Vimeo",
"description": "The name of the sender for emails that are sent about the webinar."
},
"logo_uri": {
"type": "string",
"example": "/users/123/team_logos_2343",
"description": "The URI of the logo image to include in emails that are sent about the webinar."
},
"custom_link": {
"type": "string",
"example": "https://xyz.com",
"description": "The custom link for emails that are sent about the webinar."
},
"reply_email": {
"type": "string",
"example": "test@vimeo.com",
"description": "The sender's reply email address."
},
"accent_color": {
"type": "string",
"example": "#000fff",
"description": "The accent color scheme for emails that are sent about the webinar."
},
"sender_address": {
"type": "string",
"example": "Bangalore, India",
"description": "The sender's physical address."
},
"use_custom_link": {
"type": "boolean",
"example": false,
"description": "Whether to include a custom link in emails that are sent about the webinar."
},
"use_reply_email": {
"type": "boolean",
"example": false,
"description": "Whether to include a reply link in the footer of emails that are sent about the webinar."
},
"email_preferences": {
"type": "object",
"properties": {
"email_event_reminder_1_hrs": {
"type": "boolean",
"description": "Whether to send a reminder email 1 hour before the webinar starts."
},
"email_post_event_thank_you": {
"type": "boolean",
"description": "Whether to send post-event thank-you emails."
},
"email_event_reminder_15_min": {
"type": "boolean",
"description": "Whether to send a reminder email 15 minutes before the webinar starts."
},
"email_event_reminder_24_hrs": {
"type": "boolean",
"description": "Whether to send a reminder email 24 hours before the webinar starts."
},
"email_registration_confirmation": {
"type": "boolean",
"description": "Whether to send a registration confirmation email after webinar registration."
},
"email_post_event_no_show_thank_you": {
"type": "boolean",
"description": "Whether to send post-event thank-you emails to no-shows."
}
},
"description": "The preferences for emails that are sent about the webinar."
},
"sender_policy_url": {
"type": "string",
"example": "vimeo.com/policy",
"description": "The URL of the sender's privacy policy."
},
"use_sender_address": {
"type": "boolean",
"example": false,
"description": "Whether to include the sender's physical address in the footer of emails that are sent about the webinar."
},
"use_sender_policy_url": {
"type": "boolean",
"example": false,
"description": "Whether to include the URL of the sender's privacy policy in the footer of emails that are sent about the webinar."
},
"email_post_event_thank_you": {
"type": "object",
"description": "The email customization details for the webinar post-event thank-you email."
},
"email_event_reminder_24_hrs": {
"type": "object",
"description": "The email customization details for the webinar reminder email, which goes out 24 hours before the event."
},
"email_registration_confirmation": {
"type": "object",
"description": "The email customization details for the webinar registration confirmation email."
}
}
}
WebinarEmailsCustomizePreferencesRequest1
{
"type": "object",
"properties": {
"from": {
"type": "string",
"example": "Vimeo",
"description": "The name of the sender for emails that are sent about the webinar."
},
"logo_uri": {
"type": "string",
"example": "/users/123/team_logos_2343",
"description": "The URI of the logo image to include in emails that are sent about the webinar."
},
"custom_link": {
"type": "string",
"example": "https://xyz.com",
"description": "The custom link for emails that are sent about the webinar."
},
"reply_email": {
"type": "string",
"example": "test@vimeo.com",
"description": "The sender's reply email address."
},
"accent_color": {
"type": "string",
"example": "#000fff",
"description": "The accent color scheme for emails that are sent about the webinar."
},
"sender_address": {
"type": "string",
"example": "Bangalore, India",
"description": "The sender's physical address."
},
"use_custom_link": {
"type": "boolean",
"example": false,
"description": "Whether to include a custom link in emails that are sent about the webinar."
},
"use_reply_email": {
"type": "boolean",
"example": false,
"description": "Whether to include a reply link in the footer of emails that are sent about the webinar."
},
"email_preferences": {
"type": "object",
"properties": {
"email_event_reminder_1_hrs": {
"type": "boolean",
"description": "Whether to send a reminder email 1 hour before the webinar starts."
},
"email_post_event_thank_you": {
"type": "boolean",
"description": "Whether to send post-event thank-you emails."
},
"email_event_reminder_15_min": {
"type": "boolean",
"description": "Whether to send a reminder email 15 minutes before the webinar starts."
},
"email_event_reminder_24_hrs": {
"type": "boolean",
"description": "Whether to send a reminder email 24 hours before the webinar starts."
},
"email_registration_confirmation": {
"type": "boolean",
"description": "Whether to send a registration confirmation email after webinar registration."
},
"email_post_event_no_show_thank_you": {
"type": "boolean",
"description": "Whether to send post-event thank-you emails to no-shows."
}
},
"description": "The preferences for emails that are sent about the webinar."
},
"sender_policy_url": {
"type": "string",
"example": "vimeo.com/policy",
"description": "The URL of the sender's privacy policy."
},
"use_sender_address": {
"type": "boolean",
"example": false,
"description": "Whether to include the sender's physical address in the footer of emails that are sent about the webinar."
},
"use_sender_policy_url": {
"type": "boolean",
"example": false,
"description": "Whether to include the URL of the sender's privacy policy in the footer of emails that are sent about the webinar."
},
"email_post_event_thank_you": {
"type": "object",
"description": "The email customization details for the webinar post-event thank-you email."
},
"email_event_reminder_24_hrs": {
"type": "object",
"description": "The email customization details for the webinar reminder email, which goes out 24 hours before the event."
},
"email_registration_confirmation": {
"type": "object",
"description": "The email customization details for the webinar registration confirmation email."
}
}
}
WebinarEssentialsCreateWebinarRequest
{
"type": "object",
"required": [
"title"
],
"properties": {
"title": {
"type": "string",
"example": "Interviews Daily",
"description": "The title of the webinar."
},
"privacy": {
"type": "object",
"properties": {
"view": {
"enum": [
"anybody",
"nobody",
"password",
"team"
],
"type": "string",
"example": "anybody",
"description": "The initial privacy of the webinar.\n\nOption descriptions:\n * `anybody` - Anyone can access the webinar. This privacy setting appears as `Public` on the Vimeo front end.\n * `nobody` - No one except the owner can access the webinar. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the event.\n * `team` - Only members of the authenticated user's team can access the webinar.\n"
},
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"example": "private",
"description": "The initial embed privacy of the webinar.\n\nOption descriptions:\n * `private` - The webinar can't be embedded on any domain.\n * `public` - The webinar can be embedded on any domain.\n * `whitelist` - The webinar can be embedded on whitelisted domains only.\n"
}
},
"description": "The privacy settings of the webinar."
},
"password": {
"type": "string",
"example": "gogo",
"description": "The password when **privacy.view** is `password`. Anyone with the password can view the videos generated by streaming to the webinar event."
},
"schedule": {
"type": "object",
"properties": {
"type": {
"enum": [
"single",
"weekly"
],
"type": "string",
"example": "weekly",
"description": "How often the webinar is expected to be live.\n\nOption descriptions:\n * `single` - The webinar is live one time only.\n * `weekly` - The webinar is live on a weekly basis. _This field is deprecated._\n"
},
"end_time": {
"type": "string",
"example": "2019-06-21T14:00:00+00:00",
"description": "The time in ISO 8601 format when the webinar is expected to end, with support for different time offsets. This parameter is required when **schedule.type** is `single`."
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"description": "A non-empty array of weekdays on which the webinar is expected to be live. Weekdays can range from 1 to 7, where 1 is Monday and 7 is Sunday. This parameter is required when **schedule.type** is `weekly`. _This field is deprecated._"
},
"daily_time": {
"type": "string",
"example": "14:00:00Z",
"description": "The time in ISO 8601 format when the webinar is expected to be live, with the zero UTC offset `Z`. This parameter is required when **schedule.type** is `weekly`. _This field is deprecated._"
},
"start_time": {
"type": "string",
"example": "2018-06-21T14:00:00+00:00",
"description": "The time in ISO 8601 format when the webinar is expected to be live, with support for different time offsets. This parameter is required when **schedule.type** is `single`."
}
},
"description": "Information about the time or times that the webinar is expected to be live."
},
"time_zone": {
"type": "string",
"example": "America/New_York",
"description": "The time zone used in resolving the timestamps that are included in the automatically generated video titles for the webinar."
},
"folder_uri": {
"type": "number",
"example": 0,
"description": "The URI of the webinar's folder."
},
"description": {
"type": "string",
"example": "In this episode, we interview a surprise guest",
"description": "The description of the webinar."
},
"email_settings": {
"type": "object",
"properties": {
"from": {
"type": "string",
"example": "Vimeo",
"description": "The name of the sender for emails that are sent about the webinar. _This field is deprecated._"
},
"logo_uri": {
"type": "string",
"example": "/users/123/team_logos_2343",
"description": "The URI of the logo image to include in emails that are sent about the webinar. _This field is deprecated._"
},
"custom_link": {
"type": "string",
"example": "https://xyz.com",
"description": "The custom link for emails that are sent about the webinar. _This field is deprecated._"
},
"reply_email": {
"type": "string",
"example": "test@vimeo.com",
"description": "The sender's reply email address. _This field is deprecated._"
},
"accent_color": {
"type": "string",
"example": "#000fff",
"description": "The accent color scheme for emails that are sent about the webinar. _This field is deprecated._"
},
"sender_address": {
"type": "string",
"example": "Bangalore, India",
"description": "The sender's physical address. _This field is deprecated._"
},
"use_custom_link": {
"type": "boolean",
"example": false,
"description": "Whether to include a custom link in emails that are sent about the webinar. _This field is deprecated._"
},
"use_reply_email": {
"type": "boolean",
"example": false,
"description": "Whether to include a reply link in the footer of emails that are sent about the webinar. _This field is deprecated._"
},
"email_preferences": {
"type": "object",
"properties": {
"email_event_reminder_1_hrs": {
"type": "boolean",
"description": "Whether to send a reminder email 1 hour before the webinar starts. _This field is deprecated._"
},
"email_post_event_thank_you": {
"type": "boolean",
"description": "Whether to send post-event thank-you emails. _This field is deprecated._"
},
"email_event_reminder_15_min": {
"type": "boolean",
"description": "Whether to send a reminder email 15 minutes before the webinar starts. _This field is deprecated._"
},
"email_event_reminder_24_hrs": {
"type": "boolean",
"description": "Whether to send a reminder email 24 hours before the webinar starts. _This field is deprecated._"
},
"email_registration_confirmation": {
"type": "boolean",
"description": "Whether to send a registration confirmation email after webinar registration. _This field is deprecated._"
},
"email_post_event_no_show_thank_you": {
"type": "boolean",
"description": "Whether to send post-event thank-you emails to no-shows. _This field is deprecated._"
}
},
"description": "The preferences for emails that are sent about the webinar. _This field is deprecated._"
},
"sender_policy_url": {
"type": "string",
"example": "vimeo.com/policy",
"description": "The URL of the sender's privacy policy. _This field is deprecated._"
},
"use_sender_address": {
"type": "boolean",
"example": false,
"description": "Whether to include the sender's physical address in the footer of emails that are sent about the webinar. _This field is deprecated._"
},
"use_sender_policy_url": {
"type": "boolean",
"example": false,
"description": "Whether to include the URL of the sender's privacy policy in the footer of emails that are sent about the webinar. _This field is deprecated._"
}
},
"description": "The settings for emails that are sent about the webinar. _This field is deprecated._"
}
}
}
WebinarEssentialsUpdateWebinarBelongingToAuthenticatedUserRequest
{
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Interviews Daily",
"description": "The title of the webinar."
},
"status": {
"enum": [
"ended",
"started"
],
"type": "string",
"example": "started",
"description": "The status of the webinar.\n\nOption descriptions:\n * `ended` - The webinar has ended.\n * `started` - The webinar has started.\n"
},
"privacy": {
"type": "object",
"properties": {
"view": {
"enum": [
"anybody",
"nobody",
"password",
"team"
],
"type": "string",
"example": "anybody",
"description": "The initial privacy of the webinar. This can't be updated once the webinar is in session.\n\nOption descriptions:\n * `anybody` - Anyone can access the webinar. This privacy setting appears as `Public` on the Vimeo front end.\n * `nobody` - No one except the owner can access the webinar. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the live event.\n * `team` - Only members of the authenticated user's team can access the webinar.\n"
},
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"example": "private",
"description": "The initial embed privacy of the webinar.\n\nOption descriptions:\n * `private` - The webinar can't be embedded on any domain.\n * `public` - The webinar can be embedded on any domain.\n * `whitelist` - The webinar can be embedded on whitelisted domains only.\n"
}
},
"description": "The privacy settings of the webinar."
},
"password": {
"type": "string",
"example": "gogo",
"description": "The password when **privacy.view** is `password`. Anyone with the password can view the videos generated by streaming to the webinar event."
},
"schedule": {
"type": "object",
"properties": {
"type": {
"enum": [
"single",
"weekly"
],
"type": "string",
"example": "weekly",
"description": "How often the webinar is expected to be live.\n\nOption descriptions:\n * `single` - The webinar is live one time only.\n * `weekly` - The webinar is live on a weekly basis. _This field is deprecated._\n"
},
"end_time": {
"type": "string",
"example": "2019-06-21T14:00:00+00:00",
"description": "The time in ISO 8601 format when the webinar is expected to end, with support for different time offsets. This parameter is required when **schedule.type** is `single`."
},
"weekdays": {
"type": "array",
"items": {
"type": "string"
},
"description": "A non-empty array of weekdays on which the webinar is expected to be live. Weekdays can range from 1 to 7, where 1 is Monday and 7 is Sunday. This parameter is required when **schedule.type** is `weekly`. _This field is deprecated._"
},
"daily_time": {
"type": "string",
"example": "14:00:00Z",
"description": "The time in ISO 8601 format when the webinar is expected to be live, with the zero UTC offset `Z`. This parameter is required when **schedule.type** is `weekly`. _This field is deprecated._"
},
"start_time": {
"type": "string",
"example": "2018-06-21T14:00:00+00:00",
"description": "The time in ISO 8601 format when the webinar is expected to be live, with support for different time offsets. This parameter is required when **schedule.type** is `single`."
}
},
"description": "Information about the time or times that the webinar is expected to be live. Please note that you can't update this setting once the webinar has started."
},
"time_zone": {
"type": "string",
"example": "America/New_York",
"description": "The time zone used in resolving the timestamps that are included in the automatically generated video titles for the webinar."
},
"description": {
"type": "string",
"example": "In this episode, we interview a surprise guest",
"description": "The description of the webinar."
},
"email_settings": {
"type": "object",
"properties": {
"from": {
"type": "string",
"example": "Vimeo",
"description": "The name of the sender for emails that are sent about the webinar. _This field is deprecated._"
},
"logo_uri": {
"type": "string",
"example": "/users/123/team_logos/2343",
"description": "The URI of the logo image to include in emails that are sent about the webinar. _This field is deprecated._"
},
"custom_link": {
"type": "string",
"example": "https://xyz.com",
"description": "The custom link for emails that are sent about the webinar. _This field is deprecated._"
},
"reply_email": {
"type": "string",
"example": "test@vimeo.com",
"description": "The sender's reply email address. _This field is deprecated._"
},
"accent_color": {
"type": "string",
"example": "#000fff",
"description": "The accent color scheme for emails that are sent about the webinar. _This field is deprecated._"
},
"sender_address": {
"type": "string",
"example": "Bangalore, India",
"description": "The sender's physical address. _This field is deprecated._"
},
"use_custom_link": {
"type": "boolean",
"example": false,
"description": "Whether to include a custom link in emails that are sent about the webinar. _This field is deprecated._"
},
"use_reply_email": {
"type": "boolean",
"example": false,
"description": "Whether to include a reply link in the footer of emails that are sent about the webinar. _This field is deprecated._"
},
"email_preferences": {
"type": "object",
"properties": {
"email_event_reminder_1_hrs": {
"type": "boolean",
"description": "Whether to send a reminder email 1 hour before the webinar starts. _This field is deprecated._"
},
"email_post_event_thank_you": {
"type": "boolean",
"description": "Whether to send post-event thank-you emails. _This field is deprecated._"
},
"email_event_reminder_15_min": {
"type": "boolean",
"description": "Whether to send a reminder email 15 minutes before the webinar starts. _This field is deprecated._"
},
"email_event_reminder_24_hrs": {
"type": "boolean",
"description": "Whether to send a reminder email 24 hours before the webinar starts. _This field is deprecated._"
},
"email_registration_confirmation": {
"type": "boolean",
"description": "Whether to send a registration confirmation email after webinar registration. _This field is deprecated._"
},
"email_post_event_no_show_thank_you": {
"type": "boolean",
"description": "Whether to send post-event thank-you emails to no-shows. _This field is deprecated._"
}
},
"description": "The preferences for emails that are sent about the webinar. _This field is deprecated._"
},
"sender_policy_url": {
"type": "string",
"example": "vimeo.com/policy",
"description": "The URL of the sender's privacy policy. _This field is deprecated._"
},
"use_sender_address": {
"type": "boolean",
"example": false,
"description": "Whether to include the sender's physical address in the footer of emails that are sent about the webinar. _This field is deprecated._"
},
"use_sender_policy_url": {
"type": "boolean",
"example": false,
"description": "Whether to include the URL of the sender's privacy policy in the footer of emails that are sent about the webinar. _This field is deprecated._"
}
},
"description": "The settings for emails that are sent about the webinar. _This field is deprecated._"
}
}
}