BRbrightcovelearning
Videos

Update a Video Variant

Changed on

Updates a language variant for a video metadata

patch/v1/accounts/{{account_id}}/videos/{{video_id}}/variants{language}}

Request

  • Base URL
    https://cms.api.brightcove.com
  • URL
    https://cms.api.brightcove.com/v1/accounts/{{account_id}}/videos/{{video_id}}/variants{language}}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://oauth.brightcove.com/v4/access_token scopes: video-cloud/video/read

Path parameters

account_idstring required

Video Cloud account ID.

video_idstring required

Video ID (specified as {video_id}}).

languagestring required

The language for the variant in the language-country code format (examples: en-US, es-ES)

Headers

Content-Typestring required

Content-Type: application/json

Authorizationstring required

Authorization: Bearer {access_token} - see Getting Access Tokens

Request body

languagestring

The language for this variant in the language-country code format (examples: en-US, es-ES) Note that language is only included when you create a variant - you must NOT include it when updating the variant

namestring

The title of the video in this language

descriptionstring

The video short description in this language

long_descriptionstring

The video long description in this language

custom_fieldsobject

map of fieldname: value pairs, where values are for this language; values have a maximum length of 1024 single-byte characters. Note: be sure to use the internal name for the field, not the display name

Example request

{
  "language": "es-ES"
}

Response

200

languagestring

The language for this variant in the language-country code format (examples: en-US, es-ES) Note that language is only included when you create a variant - you must NOT include it when updating the variant

namestring

The title of the video in this language

descriptionstring

The video short description in this language

long_descriptionstring

The video long description in this language

custom_fieldsobject

map of fieldname: value pairs, where values are for this language; values have a maximum length of 1024 single-byte characters. Note: be sure to use the internal name for the field, not the display name

Example response

{
  "language": "es-ES"
}

Changes