PATCH https://api.vidyard.com/dashboard/v1/captions/:id/draft
Set caption to draft

Sets the status field of the caption to draft only if the caption is currently in a published or complete state

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

RESPONSE
Code: 200
Content-Type: application/json
{
  "srt_url": "//cdn.vidyard.com/transcriptions/BeQAX/i-UTPAWS.srt",
  "vtt_url": "//cdn.vidyard.com/transcriptions/BeQAX/Yut9l8z4.vtt",
  "txt_url": "//cdn.vidyard.com/transcriptions/BeQAX/Yut9l8z4.txt",
  "language": "en",
  "id": 1011,
  "status": "draft",
  "formatted_text": "The quick brown fox\njumped over the lazy dog.",
  "plain_text": "The quick brown fox jumped over the lazy dog.",
  "created_at": 1442297000,
  "updated_at": 1442297001,
  "formatted_language_name": "English (en)",
  "localized_language_name": "English",
  "is_default": true,
  "notes": "Transcription request notes",
  "srt_download_url": "//vidyard.s3.amazonaws.com/transcriptions/BeQAX/i-UTPAWS.srt",
  "vtt_download_url": "//vidyard.s3.amazonaws.com/transcriptions/BeQAX/Yut9l8z4.vtt",
  "txt_download_url": "//vidyard.s3.amazonaws.com/transcriptions/BeQAX/Yut9l8z4.txt",
}

RESPONSE
Code: 400
Content-Type: application/json
{
  "error": "Caption must be set to 'published', or 'complete' to set it to 'draft'"
}

RESPONSE
Code: 400
Content-Type: application/json
{
  "error": "404: No caption exists with that id"
}

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

Returns

Code: 200

Description:

The updated caption with status set to draft

Param name	Description
content required	A plaintext representation of the captions content in VTT format Validations: Must be a String

Code: 400

Description:

Message returned when the caption is not currently in a valid state to be marked as draft

Param name	Description
error required	A contextual error message when a request could not be completed Validations: Must be a String

Code: 404

Description:

Message returned when the caption could not be found

Param name	Description
error required	A contextual error message when a request could not be completed Validations: Must be a String