PUT Project

Overview

---

The following table contains important information about the PUT method in regards to updating a project.

PUT Project
Method	PUT
URL or Endpoint	/api/projects/projectId
Headers	Authorization
Parameters	Not Applicable
Body	projectId

Request Body

{
  "name": "string",
  "orderNumber": 0,
  "isDefault": true,
  "subtitlesEnabledByDefault": true,
  "biskoId": "string",
  "prebidConfigId": "string",
  "chromeCastApplicationId": "string",
  "drmLicenseUrl": "string",
  "fpsCertificateUrl": "string",
  "widevineLicenseUrl": "string",
  "encodingTemplateId": 0,
  "releaseChannelId": 0
}

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

Field Name	Type	Description
name	string	The name of the project
orderNumber	integer	The order number.
isDefault	boolean	Indicates whether the project is a default project.
subtitlesEnabledByDefault	boolean	Controls whether newly ingested subtitles are automatically activated once they are ready. When enabled, captions become immediately available to viewers without manual action. When disabled, subtitles remain inactive until a user explicitly turns them on, which is useful for workflows that require editorial review.
biskoId	string	The Bisko ID.
prebidConfigId	string	The configuration ID of the prebid.
chromeCastApplicationId	string	The application ID for Chromecast.
drmLicenseUrl	string	The URL for the DRM license.
fpsCertificateUrl	string	The URL for the FPS certificate.
widevineLicenseUrl	string	The URL for the Widevine license.
encodingTemplateId	integer	The default ID of the encoding template which will be applied when encoding videos.
releaseChannelId	integer or null	Specifies the ID of release channel (player version) assigned to the project. This determines which player build is referenced in the project's player URL returned in the response model, allowing the project to be pinned to a specific player release.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicProjectId": "string",
    "name": "string",
    "publicOrganizationId": "string",
    "orderNumber": 0,
    "isDefault": true,
    "subtitlesEnabledByDefault": true,
    "useBackupBeforeLive": true,
    "cutFromChannel": true,
    "biskoId": "string",
    "prebidConfigId": "string",
    "chromeCastApplicationId": "string",
    "drmLicenseUrl": "string",
    "fpsCertificateUrl": "string",
    "widevineLicenseUrl": "string",
    "geoBlockingEnabled": true,
    "encodingTemplateId": 0,
    "releaseChannelId": 0,
    "playerUrl": "string",
    "googleCredentialsUploaded": true,
    "tokenAuthenticationEnabled": true,
    "secureTokenSecretKey": "string",
    "advancedAnalyticsRedirectId": 0,
    "aiMetadataEnabled": true,
    "advancedAnalyticsRedirect": "string",
    "defaultChannelTypeId": 0,
    "defaultChannelType": "string",
    "defaultLatencyTypeId": 0,
    "defaultLatencyType": "string",
    "defaultInputTypeId": 0,
    "defaultInputType": "string"
  },
  "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[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
publicProjectId	string	The id of the project.
name	string	The name of the project
publicOrganizationId	string	The id of the organization
orderNumber	integer($int32)	The order number.
isDefault	bool	Indicates whether the project is a default project.
subtitlesEnabledByDefault	boolean	Indicates if subtitles are enabled by default.
useBackupBeforeLive	boolean	Indicates whether the project's pre-live custom screen will automatically be shown before going live.
cutFromChannel	boolean	Indicates whether only streamed content is retained in the final video after a live stream ends.
biskoId	string	The Bisko ID.
prebidConfigId	string	The configuration ID of the prebid.
chromeCastApplicationId	string	The application ID for Chromecast.
drmLicenseUrl	string	The URL for the DRM license.
fpsCertificateUrl	string	The URL for the FPS certificate.
widevineLicenseUrl	string	The URL for the Widevine license.
geoBlockingEnabled	boolean	Indicates if geo-blocking is enabled.
encodingTemplateId	integer	The ID of the encoding template.
releaseChannelId	integer	The ID of the release channel.
playerUrl	string	The URL for the video player.
googleCredentialsUploaded	boolean	Indicates if Google credentials have been uploaded.
tokenAuthenticationEnabled	boolean	Indicates if token authentication is enabled.
secureTokenSecretKey	string	The secret key used for secure token authentication.
advancedAnalyticsRedirectId	integer	The ID of the advanced analytics redirect type.
aiMetadataEnabled	boolean	Indicates if AI metadata generation is enabled.
advancedAnalyticsRedirect	string	The name of the advanced analytics redirect type.
defaultChannelTypeId	integer	The default channel type ID for new live channels in this project.
defaultChannelType	string	The name of the default channel type.
defaultLatencyTypeId	integer	The default latency type ID for new live channels in this project.
defaultLatencyType	string	The name of the default latency type.
defaultInputTypeId	integer	The default input type ID for new live channels in this project.
defaultInputType	string	The name of the default input type.
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