PUT Subtitles

Overview

The following table contains important information about the PUT method for managing the process of updating subtitle state.

PUT Subtitle
Method	PUT
URL or Endpoint	/api​/projects​/projectId/subtitles/id
Parameters	id, projectId
Body	active

The description of the URL parameter is as follows:

Id Parameter
URL Parameter Name	Id
Mandatory	Yes
Type	integer($int32)
Description	Unique Id of the subtitle.

projectId Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

{
  "active": true
}

Information about the fields that appear when you receive the request body are displayed in the table below.

Parameter Name	Mandatory	Type	Description
active	Yes	bool	Boolean value toggle subtitle activiation

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "{id}",
    "languageId": "languageId",
    "languageName": "languageName",
    "languageCode": "languageCode",
    "videoId": "{videoId}",
    "filePath": null,
    "extension": ".vtt",
    "active": false,
    "isAutoGenerated": true
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false
errors	array[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	array[Object]	Returns the response object
id	integer($int32)	Unique identifier for the subtitle
languageId	integer($int32)	Unique identifier for the specified language
languageName	string	Name of the selected language
languageCode	string	Unique code of the language
videoId	string	Unique identifier for the video
filePath	string	A string containing the URL path to the subtitle file.
extension	string	A string representing the file extension of the subtitle file (e.g., ".vtt").
active	string	A boolean value indicating whether the subtitle file is active.
isAutoGenerated	string	A boolean value indicating whether the subtitle file was auto-generated.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed