PATCH https://api.vidyard.com/dashboard/v1/captions/:id
Update a caption

Update a caption file

Supported Formats

json

Errors

Code Description
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
422 Unprocessable Entity: body has wrong attributes
404 Not Found: The requested resource could not be found
400 Bad Request: body has wrong syntax or unable to handle request

Examples

REQUEST
Content-Type: application/json
caption_file: {
  language: "fr"
}

RESPONSE
200
{
  "language": "fr"
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
caption
optional

Validations:

  • Must be a Hash
caption[language]
optional

Language code

Validations:

  • Must be a String
caption[content]
optional

VTT content

Validations:

  • Must be a String
caption[error_message]
optional

Set error message of caption

Validations:

  • Must be a String
caption[is_default]
optional

Set the default caption for the video

Validations:

  • Parameter has to be Boolean.
caption[vtt_url]
optional

VTT URL

Validations:

  • Must be a String
caption[creator_type]
optional

Type of caption

Validations:

  • Must be a String