Create Project

This API creates a Project entity on the Indee platform.

Note: Only enterprise users who are the owners, global admins or authorized admin can call this API. Other users will be denied access.

Headers

The JWT Access token should be passed in the authorization header for all APIs.

Header	Value
Authorization	JWT token

Endpoint

POST v1/admin/projects

Request Body

    {
        "name": "Project-1",
        "ext_project_id": "project-id-596afghhxx",
        "description": "Description",
        "release_year": 2020,
        "genres": [
            "gnr-01fwzm9p60wsf5t4s3tye8r42a",
        ],
        "poster": {
            "upload_type": "ID",
            "url": "https://media.indee.tv/poster/url.png",
        },
        "banner": { 
            "upload_type": "ID",
            "url": "https://media.indee.tv/banner/url.png",
        },
        "type": "feature",
        "cast": [
            {
                "name": "Mark",
                "role": "Actor"
            },
            {
                "name": "Susan",
                "role": "Actress"
            }
        ]
    }

Parameters	Type	Description	Optional/Required
name	String	The name of the project.	Required
ext_project_id	String	A customer provided unique ID for the project.	Required
description	String	The description of the project.	Required
genres	Array	A collection of genres for the project from a predefined list	At least one item should be present.
type	String(choice--[series/feature])	Type of content	Required
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
cast	Array	A collection of pairs of role and name.	Optional
release_year	int	Release year	Required

Response Body

    {

        "status_code": "A1000",
        "status_message": "Project created 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": {
                "status_code": "A3000",
                "status_message": "Request for adding project poster submitted"
            },
        "banner": {
            "status_code": "A3003",
            "status_message": "Request for adding project banner submitted"
        },
        "name": "film",
        "cast": [
            {
                "name": "Mark",
                "role": "Actor"
            },
            {
                "name": "Susan",
                "role": "Actress"
            }
        ],
        "type": "feature"
    },

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.
release_year	int	The year of the release.
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.
type	String(choice(series/feature))	Type of content.

Error and Success Codes

For error codes and success codes, see Common Error Codes section.