POST /api/v2/projects
Create project

Headers

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

Params

Param name	Description
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

// Successful request
POST /api/v2/projects
{
  "title": "Sample Project",
  "description": "Sample project from API V2",
  "category": "Sample",
  "tags": [
    "sample",
    "test"
  ]
}
200
{
  "project": {
    "id": "xPTGCww83_GqB8yO5fXR",
    "external_id": null,
    "project_id": null,
    "owner": "admin-user-219@example.com",
    "title": "Sample Project",
    "description": "Sample project from API V2",
    "category": "sample",
    "tags": [
      "sample",
      "test"
    ],
    "media_type": "project",
    "isPublic": false,
    "thumbnail_asset_id": null,
    "created_date": "2023-11-27T09:43:24.619Z",
    "modification_date": "2023-11-27T09:43:24.619Z",
    "deleted": null,
    "original_title": "Sample Project"
  }
}

// Missing required parameters
POST /api/v2/projects
{
  "description": "Sample project from API V2",
  "category": "Sample",
  "tags": [
    "sample",
    "test"
  ]
}
422
{
  "error": "Missing parameter title"
}

// With invalid parameters
POST /api/v2/projects
{
  "title": "Testing too long title: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
400
{
  "error": "Title is too long (maximum is 255 characters)"
}

Errors

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