Edit Project
This API allows the admin user to edit the project created on Indee platform.
Headers
The JWT Access token should be passed in the authorization header for all APIs.
Header | Value |
---|---|
Authorization | JWT token |
Endpoint
Request Body
{
"name": "Project-1",
"description": "<p>Description</p>",
"release_year": 2020,
"genres": [
"gnr-01fwzm9p60wsf5t4s3tye8r42a",
],
"poster": {
},
"banner": {
"upload_type": "ID",
"url": "https://media.indee.tv/banner/url.png",
"action": "add"
},
"type": "series",
"cast": [
{
"name": "Mark",
"role": "Actor"
},
{
"name": "Susan",
"role": "Actress"
}
]
}
Parameters | Type | Description | Optional/Required |
---|---|---|---|
name |
String | The name of the project. | Required |
description |
String | The description of the project. | Required |
release_year |
Integer | The year of the release. | Required |
genres |
Array | A collection of genres for the project from a predefined list | At least one item should be present. |
poster |
Dict | A dictionary containing url and status for the project poster. | Optional |
banner |
Dict | A dictionary containing url and status for the project banner. | Optional |
upload_type |
String | Determines the type of upload - CU or ID . Indee supports two media upload approaches—customer uploaded (CU) and Indee downloaded (ID) —applicable for audio, video, and images. To know more, refer to Understanding Media Upload Approaches. |
Required |
action |
String | Determines the action of edit. Available values: add and delete . |
Required |
type |
String(choice--[series/feature]) | Type of content | Required |
cast |
Array | A collection of pairs of role and name. | Optional |
Response Body
{
"status_code": "A1001",
"status_message": "Project Updated Successfully",
"key": "prj-01hpr6t70xedtepht8b196krsy",
"ext_project_id": "project-id-596afghhxx",
"release_year": 2020,
"genres": [
{
"key": "gnr-01fwzm9p60wsf5t4s3tye8r42a",
"name": "Horror",
"description": "description"
}
],
"description": "<p>Description</p>",
"poster": {
"url": "https://media.devtest.indee.tv/2582/2582_poster_1908335069.jpg?Expires=1708433103&Signature=SLya1ftOiEMsr1-3Ud5t3ufOcTORgU0aLMZoRxUb1TpjMKcPYQJXlrXSt8DgpLo87HjKtvkOY6kw5sylAjUY5P~hMbvr7S5Ow9Wog3Il2fzOZVVbYv8kKrkD8RUjKmPYL1k0e8D0M~npByY~hQq0RxmSyfEi~bNuOSn~jjr7BbU4pvp58Kp4EOv4iJxjYseSF~Ft8bpbNONpSeehRNRLTfL19YYOp5xwXkqcp2~LnfoKyQ9nyWktsDqXF29rnQUgV0D83VucpvE-fp-CAsPZzxuy0qskaq-o2qdB1ikJ3ruWf8vmAvXi8BDM8iSRmxTh3nwkVIlC3e3L15fDeoK4pw__&Key-Pair-Id=K2NTQVU4FZL5P0",
"status_code": "A3002",
"status_message": "Project poster added successfully"
},
"banner": {
"url": "https://media.devtest.indee.tv/2582/2582_banner_1908335069.jpg?Expires=1708433103&Signature=SLya1ftOiEMsr1-3Ud5t3ufOcTORgU0aLMZoRxUb1TpjMKcPYQJXlrXSt8DgpLo87HjKtvkOY6kw5sylAjUY5P~hMbvr7S5Ow9Wog3Il2fzOZVVbYv8kKrkD8RUjKmPYL1k0e8D0M~npByY~hQq0RxmSyfEi~bNuOSn~jjr7BbU4pvp58Kp4EOv4iJxjYseSF~Ft8bpbNONpSeehRNRLTfL19YYOp5xwXkqcp2~LnfoKyQ9nyWktsDqXF29rnQUgV0D83VucpvE-fp-CAsPZzxuy0qskaq-o2qdB1ikJ3ruWf8vmAvXi8BDM8iSRmxTh3nwkVIlC3e3L15fDeoK4pw__&Key-Pair-Id=K2NTQVU4FZL5P0",
"status_code": "A3006",
"status_message": "Project banner added successfully"
},
"name": "film",
"cast": [
{
"name": "Mark",
"role": "Actor"
},
{
"name": "Susan",
"role": "Actress"
}
],
"type": "series"
}
Field | Type | Description |
---|---|---|
status_code |
String | Indee provided status code. |
status_message |
String | The message associated with the status code. |
key |
String | The unique key of the project. |
ext_project_id |
String | A customer provided unique ID for the project. |
name |
String | The name of the project. |
description |
String | A description of the project. |
genres |
Array | A collection of genres for the project from a predefined list. |
poster |
dict | A dictionary containing url and status for the project poster. |
banner |
dict | A dictionary containing url and status for the project banner. |
cast |
Array | A collection of pairs of role and name. |
release_year |
int | Release year |
type |
String | Type of content. Supported values are series and feature |
Error and Success Codes
For error codes and success codes, see Common Error Codes section.