OnDemandGenresGetGenresResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-genre"
}
}
OnDemandPostersGetOnDemandPagePostersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
OnDemandPostersUpdatePosterRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether this poster is the one that appears on the On Demand page."
}
}
}
OnDemandPromotionsAddPromotionToPageRequest
{
"type": "object",
"required": [
"download",
"stream_period",
"total",
"type"
],
"properties": {
"code": {
"type": "string",
"example": "sxsw2018",
"description": "The promotion code. This parameter is ignored when the promotion type is `batch`."
},
"type": {
"enum": [
"batch",
"single"
],
"type": "string",
"description": "The type of the promotion. When **access_type** is `vip`, the value for this parameter must be `batch`.\n\nOption descriptions:\n * `batch` - The promotion type that generates many random codes to use one time each.\n * `single` - The promotion type that generates one code to use many times.\n"
},
"label": {
"type": "string",
"example": "sxsw",
"description": "The description of the promotion when the promotion type is `batch`. This parameter is ignored when the promotion type is `single`."
},
"total": {
"type": "number",
"example": 9,
"description": "When **type** is `batch`, the total number of promotions to generate. When **type** is `single`, the total number of uses of the promotion."
},
"download": {
"type": "boolean",
"example": true,
"description": "Whether the promotion grants download access to On Demand content. This field is required only when the download access hasn't been defined in the On Demand container, or when **access_type** is `vip` or **product_type** is `buy`."
},
"end_time": {
"type": "string",
"example": "1526089920",
"description": "The time at which the promotion period ends. If this parameter has no value, the promotion never expires."
},
"start_time": {
"type": "string",
"example": "1526089920",
"description": "The time at which the promotion period starts. If this parameter has no value, the start time defaults to the time at which the promotion was created."
},
"access_type": {
"enum": [
"default",
"vip"
],
"type": "string",
"description": "The promotion access type, which is a purchase option that isn't available in the On Demand container. Use the **download** and **stream_period** parameters to define additional characteristics for the `vip` type.\n\nOption descriptions:\n * `default` - The promotion grants a discount on the existing purchase options for an On Demand container.\n * `vip` - The promotion grants free access to On Demand content before it's released.\n"
},
"percent_off": {
"type": "number",
"example": 50,
"description": "The percentage of the discount. This parameter is applicable only when **discount_type** is `percent`."
},
"product_type": {
"enum": [
"any",
"buy",
"buy_episode",
"rent",
"rent_episode",
"subscribe"
],
"type": "string",
"description": "The type of transaction to which the promotion applies. When **access_type** is `default`, the default value is `any`. When **access_type** is `vip`, the default value is `rent` and the only valid product types are `buy` and `rent`.\n\nOption descriptions:\n * `any` - The promotion applies to any transaction.\n * `buy` - The promotion applies only to purchased products.\n * `buy_episode` - The promotion applies only to purchased episodes.\n * `rent` - The promotion applies only to rented products.\n * `rent_episode` - The promotion applies only to rented episodes.\n * `subscribe` - The promotion applies only to subscriptions.\n"
},
"discount_type": {
"enum": [
"free",
"percent"
],
"type": "string",
"description": "The type of discount offered by the promotion code. When **access_type** is `vip`, the value of this parameter must be `free`.\n\nOption descriptions:\n * `free` - The discount reduces the price to zero.\n * `percent` - The discount reduces the price by the percentage defined in the **percent_off** parameter.\n"
},
"stream_period": {
"enum": [
"1_week",
"1_year",
"24_hour",
"30_day",
"3_month",
"48_hour",
"6_month",
"72_hour"
],
"type": "string",
"description": "The amount of time for which the user can access On Demand content upon redeeming a promotion code. This parameter is required only when the streaming period isn't defined in the On Demand container, or when creating promotions where **access_type** is `vip` or **product_type** is `rent`.\n\nOption descriptions:\n * `1_week` - The user can access On Demand content for a maximum of 1 week after redeeming a promotion code.\n * `1_year` - The user can access On Demand content for a maximum of 1 year after redeeming a promotion code.\n * `24_hour` - The user can access On Demand content for a maximum of 24 hours after redeeming a promotion code.\n * `30_day` - The user can access On Demand content for a maximum of 30 days after redeeming a promotion code.\n * `3_month` - The user can access On Demand content for a maximum of 3 months after redeeming a promotion code.\n * `48_hour` - The user can access On Demand content for a maximum of 48 hours after redeeming a promotion code.\n * `6_month` - The user can access On Demand content for a maximum of 6 months after redeeming a promotion code.\n * `72_hour` - The user can access On Demand content for a maximum of 72 hours after redeeming a promotion code.\n"
}
}
}
OnDemandPurchasesAndRentalsGetAllUserPurchasesAndRentalsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-page"
}
}
OnDemandPurchasesAndRentalsListUserPurchasesAndRentalsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-page"
}
}
OnDemandRegionsAddMultipleRequest
{
"type": "object",
"required": [
"countries"
],
"properties": {
"countries": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of country codes for the regions to add."
}
}
}
OnDemandRegionsGetAllResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-region"
}
}
OnDemandRegionsRemoveMultipleRequest
{
"type": "object",
"properties": {
"countries": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of country codes for the regions to remove."
}
}
}
OnDemandRegionsRemoveMultipleResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-region"
}
}
OnDemandSeasonsGetAllVideosInSeasonResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
OnDemandSeasonsListAllResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-season"
}
}
OnDemandVideosAddVideoToPageRequest
{
"type": "object",
"required": [
"type"
],
"properties": {
"buy": {
"type": "object",
"properties": {
"price": {
"type": "object",
"properties": {
"AUD": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in Australian dollars."
},
"CAD": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in Canadian dollars."
},
"CHF": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in Swiss francs."
},
"DKK": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in Danish krone."
},
"EUR": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in euros."
},
"GBP": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in British pounds."
},
"JPY": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in Japanese yen."
},
"KRW": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in South Korean won."
},
"NOK": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in Norwegian krone."
},
"PLN": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in Polish zloty."
},
"SEK": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in Swedish krona."
},
"USD": {
"type": "number",
"example": 1.99,
"description": "The purchase price of the video in United States dollars. This parameter is required when **buy.active** is `true`."
}
}
}
}
},
"rent": {
"type": "object",
"properties": {
"price": {
"type": "object",
"properties": {
"AUD": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Australian dollars."
},
"CAD": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Canadian dollars."
},
"CHF": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Swiss francs."
},
"DKK": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Danish krone."
},
"EUR": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in euros."
},
"GBP": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in British pounds."
},
"JPY": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Japanese yen."
},
"KRW": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in South Korean won."
},
"NOK": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Norwegian krone."
},
"PLN": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Polish zloty."
},
"SEK": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in Swedish krona."
},
"USD": {
"type": "number",
"example": 0.99,
"description": "The rental price of the video in United States dollars. This parameter is required when **rent.active** is `true`."
}
}
}
}
},
"type": {
"enum": [
"extra",
"main",
"trailer"
],
"type": "string",
"description": "The type of the video.\n\nOption descriptions:\n * `extra` - The video type is extra footage.\n * `main` - The video type is the main video.\n * `trailer` - The video type is a trailer.\n"
},
"position": {
"type": "number",
"example": 10,
"description": "The position of the video in the On Demand collection."
},
"release_year": {
"type": "number",
"example": 2018,
"description": "The release year of the video."
}
}
}
OnDemandVideosGetAllVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/on-demand-video"
}
}
PaymentsEssentialsListPaymentMethodsRequest
{
"type": "object",
"properties": {
"type": {
"enum": [
"applepay",
"bank_account",
"card",
"googlepay",
"paypal"
],
"type": "string",
"description": "The type of payment method.\n\nOption descriptions:\n * `applepay` - The payment method is Apple Pay.\n * `bank_account` - The payment method is a bank account.\n * `card` - The payment method is a credit or debit card.\n * `googlepay` - The payment method is Google Pay.\n * `paypal` - The payment method is a PayPal account.\n"
}
}
}
PaymentsEssentialsListPaymentMethodsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/payment-method"
}
}
PortfoliosEssentialsGetAllUserPortfoliosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/portfolio"
}
}
PortfoliosVideosGetAllPortfolioVideos200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
PortfoliosVideosGetAllPortfolioVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
SearchUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
SearchVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
ShowcasesCustomShowcaseLogosListAllCustomLogosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
ShowcasesCustomShowcaseLogosReplaceLogoRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether to make this image the active showcase logo."
}
}
}
ShowcasesCustomShowcaseThumbnailsListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
ShowcasesCustomShowcaseThumbnailsReplaceCustomThumbnailRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether to make this image the active custom showcase thumbnail."
}
}
}
ShowcasesEssentialsCreateUserShowcaseRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Vimeo Holiday Videos!",
"description": "The name of the showcase."
},
"sort": {
"enum": [
"added_first",
"added_last",
"alphabetical",
"arranged",
"comments",
"likes",
"newest",
"oldest",
"plays"
],
"type": "string",
"description": "The default sort order of the videos as they appear in the showcase.\n\nOption descriptions:\n * `added_first` - The videos appear according to when they were added to the showcase, with the most recently added first.\n * `added_last` - The videos appear according to when they were added to the showcase, with the most recently added last.\n * `alphabetical` - The videos appear alphabetically by their title.\n * `arranged` - The videos appear as arranged by the owner of the showcase.\n * `comments` - The videos appear according to their number of comments.\n * `likes` - The videos appear according to their number of likes.\n * `newest` - The videos appear in chronological order with the newest first.\n * `oldest` - The videos appear in chronological order with the oldest first.\n * `plays` - The videos appear according to their number of plays.\n"
},
"theme": {
"enum": [
"dark",
"standard"
],
"type": "string",
"description": "The color theme of the showcase.\n\nOption descriptions:\n * `dark` - The showcase uses the dark theme.\n * `standard` - The showcase uses the standard theme.\n"
},
"layout": {
"enum": [
"grid",
"player"
],
"type": "string",
"description": "The type of layout for presenting the showcase.\n\nOption descriptions:\n * `grid` - The videos appear in a grid.\n * `player` - The videos appear in the player.\n"
},
"privacy": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"team",
"unlisted"
],
"type": "string",
"description": "The privacy level of the showcase.\n\nOption descriptions:\n * `anybody` - Anyone can access the showcase, either on Vimeo or through an embed.\n * `embed_only` - The showcase doesn't appear on Vimeo, but it can be embedded on other sites.\n * `nobody` - No one can access the showcase, including the authenticated user.\n * `password` - Only those with the password can access the showcase.\n * `team` - Only members of the authenticated user's team can access the showcase.\n * `unlisted` - The showcase can't be accessed if the URL omits its unlisted hash.\n"
},
"hide_nav": {
"type": "boolean",
"example": true,
"description": "Whether to hide Vimeo navigation when displaying the showcase."
},
"password": {
"type": "string",
"example": "hunter1",
"description": "The showcase's password. This field is required only when **privacy** is `password`."
},
"brand_color": {
"type": "string",
"example": "ff66ee",
"description": "The hexadecimal code for the color of the player buttons and showcase controls."
},
"description": {
"type": "string",
"example": "Vimeo holiday videos!",
"description": "The description of the showcase."
},
"review_mode": {
"type": "boolean",
"example": true,
"description": "Whether showcase videos use the review mode URL."
},
"hide_upcoming": {
"type": "boolean",
"example": false,
"description": "Whether to include the upcoming event in the showcase."
},
"hide_from_vimeo": {
"type": "boolean",
"example": false,
"description": "Whether the showcase should be hidden from Vimeo when unlisted."
}
}
}
ShowcasesEssentialsEditShowcaseRequest
{
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "my-custom-url",
"nullable": true,
"description": "The custom Vimeo URL of the showcase."
},
"name": {
"type": "string",
"example": "Vimeo Holiday Videos!",
"description": "The name of the showcase."
},
"sort": {
"enum": [
"added_first",
"added_last",
"alphabetical",
"arranged",
"comments",
"likes",
"newest",
"oldest",
"plays"
],
"type": "string",
"description": "The default sort order of the videos as they appear in the showcase.\n\nOption descriptions:\n * `added_first` - The videos appear according to when they were added to the showcase, with the most recently added first.\n * `added_last` - The videos appear according to when they were added to the showcase, with the most recently added last.\n * `alphabetical` - The videos appear alphabetically by their title.\n * `arranged` - The videos appear as arranged by the owner of the showcase.\n * `comments` - The videos appear according to their number of comments.\n * `likes` - The videos appear according to their number of likes.\n * `newest` - The videos appear in chronological order with the newest first.\n * `oldest` - The videos appear in chronological order with the oldest first.\n * `plays` - The videos appear according to their number of plays.\n"
},
"theme": {
"enum": [
"dark",
"standard"
],
"type": "string",
"description": "The color theme of the showcase.\n\nOption descriptions:\n * `dark` - The showcase uses the dark theme.\n * `standard` - The showcase uses the standard theme.\n"
},
"domain": {
"type": "string",
"example": "mycustomdomain.com",
"nullable": true,
"description": "The custom domain of the showcase."
},
"layout": {
"enum": [
"grid",
"player"
],
"type": "string",
"description": "The type of layout for presenting the showcase.\n\nOption descriptions:\n * `grid` - The videos appear in a grid.\n * `player` - The videos appear in the player.\n"
},
"privacy": {
"enum": [
"anybody",
"embed_only",
"nobody",
"password",
"team",
"unlisted"
],
"type": "string",
"description": "The privacy level of the showcase.\n\nOption descriptions:\n * `anybody` - Anyone can access the showcase, either on Vimeo or through an embed.\n * `embed_only` - The showcase doesn't appear on Vimeo, but it can be embedded on other sites.\n * `nobody` - No one can access the showcase, including the authenticated user.\n * `password` - Only people with the password can access the showcase.\n * `team` - Only members of the authenticated user's team can access the showcase.\n * `unlisted` - The showcase can't be accessed if the URL omits its unlisted hash.\n"
},
"hide_nav": {
"type": "boolean",
"example": true,
"description": "Whether to hide Vimeo navigation when displaying the showcase."
},
"password": {
"type": "string",
"example": "hunter1",
"description": "The showcase's password. This field is required only when **privacy** is `password`."
},
"brand_color": {
"type": "string",
"example": "ff66ee",
"description": "The hexadecimal code for the color of the player buttons and showcase controls."
},
"description": {
"type": "string",
"example": "Vimeo holiday videos!",
"description": "The description of the showcase."
},
"review_mode": {
"type": "boolean",
"example": true,
"description": "Whether showcase videos use the review mode URL."
},
"hide_upcoming": {
"type": "boolean",
"example": false,
"description": "Whether to include the upcoming event in the showcase."
},
"use_custom_domain": {
"type": "boolean",
"example": true,
"description": "Whether the user has opted for a custom domain for their showcase."
}
}
}
ShowcasesEssentialsGetAllUserShowcasesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/album"
}
}
ShowcasesShowcaseVideosCreateShowcaseThumbnailRequest
{
"type": "object",
"properties": {
"time_code": {
"type": "number",
"example": 300,
"description": "The time in seconds of the video frame to use as the thumbnail image."
}
}
}
ShowcasesShowcaseVideosCreateShowcaseThumbnailRequest1
{
"type": "object",
"properties": {
"time_code": {
"type": "number",
"example": 300,
"description": "The time in seconds of the video frame to use as the thumbnail image."
}
}
}
ShowcasesShowcaseVideosGetShowcaseVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
ShowcasesShowcaseVideosListAvailableShowcasesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/album"
}
}
ShowcasesShowcaseVideosListInShowcase200Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
ShowcasesShowcaseVideosListInShowcaseResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
ShowcasesShowcaseVideosReplaceShowcaseVideosRequest
{
"type": "object",
"required": [
"videos"
],
"properties": {
"videos": {
"type": "string",
"example": "/videos/258684937,/videos/273576296",
"description": "A comma-separated list of video URIs corresponding to the videos to add."
}
}
}
ShowcasesShowcaseVideosReplaceVideosRequest
{
"type": "object",
"required": [
"videos"
],
"properties": {
"videos": {
"type": "string",
"example": "/videos/258684937,/videos/273576296",
"description": "A comma-separated list of video URIs corresponding to the videos to add."
}
}
}
UpdateWebinarRequest
{
"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._"
}
}
}
UploadVideoRequest
{
"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."
}
}
}
UsersAnalyticsGetMetricsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/analytics"
}
}
UsersAnalyticsGetUserMetricsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/analytics"
}
}
UsersEssentialsEditVimeoAccountRequest
{
"type": "object",
"properties": {
"bio": {
"type": "string",
"example": "This is where you will find videos and news updates from the staff",
"description": "The user's bio."
},
"link": {
"type": "string",
"example": "staff",
"description": "The user's custom Vimeo URL."
},
"name": {
"type": "string",
"example": "Vimeo Staff",
"description": "The user's display name."
},
"gender": {
"enum": [
"f",
"m",
"n",
"o"
],
"type": "string",
"description": "The authenticated user's gender.\n\nOption descriptions:\n * `f` - The user's preferred pronouns are she and her.\n * `m` - The user's preferred pronouns are he and him.\n * `n` - The user would rather not give preferred pronouns.\n * `o` - The user's preferred pronouns are they and them.\n"
},
"videos": {
"type": "object",
"properties": {
"privacy": {
"type": "object",
"properties": {
"add": {
"type": "boolean",
"example": true,
"description": "Whether the user can add videos to showcases, channels, or groups by default."
},
"view": {
"enum": [
"anybody",
"contacts",
"disable",
"nobody",
"password",
"unlisted",
"users"
],
"type": "string",
"description": "Who can access the user's videos by default.\n\nOption descriptions:\n * `anybody` - Anyone can access the videos. This privacy setting appears as `Public` on the Vimeo front end.\n * `contacts` - Only the user's contacts can access the videos. _This field is deprecated._\n * `disable` - The videos are disabled. This privacy setting appears as `Hide from Vimeo` on the Vimeo front end.\n * `nobody` - No one can access the videos. This privacy setting appears as `Private` on the Vimeo front end.\n * `password` - Only those with the password can access the videos.\n * `unlisted` - The videos are unlisted.\n * `users` - Only other Vimeo members can access the videos. _This field is deprecated._\n"
},
"embed": {
"enum": [
"private",
"public",
"whitelist"
],
"type": "string",
"description": "The privacy for the user's embedded videos. The whitelist value enables you to define all valid embeddable domains. See our [Interacting with Videos](https://developer.vimeo.com/api/guides/videos/interact#set-off-site-privacy) guide for details on adding and removing domains.\n\nOption descriptions:\n * `private` - The videos can't be embedded on any domain.\n * `public` - The videos can be embedded on any domain.\n * `whitelist` - The videos can be embedded on the specified domains only.\n"
},
"comments": {
"enum": [
"anybody",
"contacts",
"nobody"
],
"type": "string",
"description": "Who can comment on the user's video uploads by default.\n\nOption descriptions:\n * `anybody` - Anyone can comment.\n * `contacts` - Only the user's contacts can comment.\n * `nobody` - No one can comment.\n"
},
"download": {
"type": "boolean",
"example": true,
"description": "Whether the user can download videos. This value becomes the default download setting for all future videos that the user uploads."
}
}
}
}
},
"location": {
"type": "string",
"example": "New York City",
"description": "The user's location."
},
"password": {
"type": "string",
"example": "hunter1",
"description": "The default password for all future videos that this user uploads. To use this field, the **videos.privacy.view** field must be `password`."
},
"content_filter": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values describing the content in the user's videos. Find the full list in the [/contentratings](https://developer.vimeo.com/api/reference/videos#get_content_ratings) endpoint. You must provide a comma-separated list if you're using a query string or an array if you're using JSON."
}
}
}
UsersFeedsGetUserFeedVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/activity-3-1"
}
}
UsersFollowersFollowMultipleUsersRequest
{
"type": "object",
"required": [
"users"
],
"properties": {
"users": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of user IDs for the authenticated user to follow."
}
}
}
UsersFollowersListAllResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
UsersFollowersListOfFollowedUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
UsersFollowersListOfFollowingUsersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/user"
}
}
UsersPicturesEditPortraitImageRequest
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"example": true,
"description": "Whether the picture is the authenticated user's active portrait."
}
}
}
UsersPicturesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/picture"
}
}
UsersWatchHistoryGetWatchedVideosResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/video"
}
}
VideosAnimatedThumbnailsCreateSetRequest
{
"type": "object",
"required": [
"duration"
],
"properties": {
"duration": {
"type": "number",
"example": 5,
"description": "The duration of the animation in seconds. The maximum value is 6."
},
"start_time": {
"type": "number",
"example": 2,
"description": "The time in seconds corresponding to the start of the animation in the video. The default value is 0."
}
}
}