UPDATE Videos

Overview

---

The following table contains information about the UPDATE method in regards to the managing process, more precisely when you want to make a UPDATE request.

UPDATE Video
Method	UPDATE
URL or Endpoint	/api/projects/projectId/videos
Headers	Authorization
Parameters	projectId
Body	Check the request body below.

The description of the URL parameter is as follows:

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

Request Body

{
  "publicId": "string",
  "name": "string",
  "title": "string",
  "description": "string",
  "publishDate": "2022-04-21T13:46:40.426Z",
  "publishEndDate": "2022-04-21T13:46:40.426Z",
  "videoPagePermalink": "string",
  "publicAdScheduleId": "string",
  "categoryId": 0,
  "entityRestrictionId": 0,
  "skipIntroState": true,
  "skipIntroFrom": 0,
  "skipIntroTo": 0,
  "source": "string",
  "author": "string",
  "tagNames": ["string"],
  "flagIds": [0],
  "customParameters": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

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

Parameter Name	Mandatory	Type	Description
publicId	Yes	integer($int32)	Public Id of the video
name	Yes	string	Name of the video
title	Yes	string	Title of the video
description	Yes	string	Description of the video
publishDate	Yes	Date	Publish date of the video
publishEndDate	Yes	Date	Publish end date of the video
videoPagePermalink	Yes	string	Permalink of the video page
publicAdScheduleId	Yes	string	The Id of the ad schedule.
categoryId	Yes	integer($int32)	Id of the category
entityRestrictionId	Yes	integer($int32)	Entity restriction Id
skipIntroState	Yes	boolean	The state of the skip intro option.
skipIntroFrom	Yes	integer($int32)	The amount of time the intro skips from
skipIntroTo	Yes	integer($int32)	The amount of time the intro skips to
source	Yes	string	The source of the video.
author	Yes	string	The author of the video.
tagNames	Yes	array[string]	An array of video tags.
flagIds	Yes	array[integer($int32)]	An array of flag Ids.
customParameters	Yes	array[Object]	An array of flag Ids.
key	Yes	string	The key of the custom parameter.
value	Yes	string	The value of the custom parameter.

Response

{
  "success": true,
  "errors": ["string"],
  "messages": ["string"],
  "result": {
    "publicId": "string",
    "name": "string",
    "title": "string",
    "description": "string",
    "thumbnailUrl": "string",
    "publishDate": "2022-04-21T13:46:40.431Z",
    "publishEndDate": "2022-04-21T13:46:40.431Z",
    "insertDate": "2022-04-21T13:46:40.431Z",
    "publishStatusId": 0,
    "publishStatusName": "string",
    "duration": 0,
    "videoPagePermalink": "string",
    "userName": "string",
    "categoryId": 0,
    "publicAdScheduleId": "string",
    "restrictionId": 0,
    "skipIntroState": true,
    "skipIntroFrom": 0,
    "skipIntroTo": 0,
    "geoBlockingRuleId": 0,
    "canEmbed": true,
    "source": "string",
    "author": "string",
    "tagNames": ["string"],
    "customParameters": [
      {
        "id": 0,
        "key": "string",
        "value": "string"
      }
    ],
    "flagIds": [0]
  },
  "resultInfo": "string",
  "statusCode": 0
}

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
publicId	integer($int32)	Public Id of the video
name	string	Name of the video
title	string	Title of the video
description	string	Description of the video
thumbnailUrl	string	The URL of the thumbnail.
publishDate	Date	Date when the video was published
publishEndDate	Date	Date when video will not be available.
insertDate	Date	Date when the video was inserted
publishStatusId	integer($int32)	Id when published
publishStatusName	string	The name of the publish status.
duration	string	Duration of the video
videoPagePermalink	string	Permalink
userName	string	The name of the user.
categoryId	integer($int32)	Id of the category.
publicAdScheduleId	string	The public Id of the ad schedule.
restrictionId	integer($int32)	Id of the restriction.
skipIntroState	Yes	boolean	The state of the skip intro option.
callBackUrl	string	URL to call when encode is finished
skipIntroFrom	Yes	integer($int32)	The amount of time the intro skips from
skipIntroTo	Yes	integer($int32)	The amount of time the intro skips to
geoBlockingRuleId	Yes	integer($int32)	The Id of the geo blocking rule.
canEmbed	boolean	Indicates whether the video can be embedded.
source	Yes	string	The source of the video.
author	Yes	string	The author of the video.
tagNames	Yes	array[string]	An array of video tags.
flagIds	Yes	array[integer($int32)]	An array of flag Ids.
customParameters	Yes	array[Object]	An array of flag Ids.
key	Yes	string	The key of the custom parameter.
value	Yes	string	The value of the custom parameter.
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