Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String

title
required

Title

Validations:

  • Must be a String

description
optional

Description

Validations:

  • Must be a String

category
optional

Category

Validations:

  • Must be a String

tags
optional

Tags

Validations:

  • Must be an array of String

external_id
optional

External ID

Validations:

  • Must be a String

Examples

// Failed request
POST /api/v2/projects/not-found-id/projects
404
{
  "error": "project not found"
}
// Failed request, missing required "title" parameter
POST /api/v2/projects/TxlGo4_aDV4br8s1yipb/projects
{
  "description": "Sample project from API V2",
  "category": "Sample"
}
422
{
  "error": "Missing parameter title"
}
// Successful request
POST /api/v2/projects/U8jU3ZtKXI9HGbSAIEKJ/projects
{
  "title": "Sample Project",
  "description": "Sample project from API V2",
  "category": "Sample"
}
200
{
  "project": {
    "id": "EEb8VQKX4KuE5dZ-FylH",
    "external_id": null,
    "project_id": "U8jU3ZtKXI9HGbSAIEKJ",
    "owner": "admin-user-182@example.com",
    "title": "Sample Project",
    "description": "Sample project from API V2",
    "category": "sample",
    "tags": [],
    "media_type": "project",
    "isPublic": false,
    "thumbnail_asset_id": null,
    "created_date": "2023-06-05T10:27:59.628Z",
    "modification_date": "2023-06-05T10:27:59.711Z",
    "deleted": null,
    "original_title": "Sample Project"
  }
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters