PUT /api/v2/projects/:project_id
Update project

Headers

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

Params

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

// Drop folder not found
PUT /api/v2/projects/not-found-id
{
  "title": "Modified Sample Drop Folder",
  "description": "Modified Description"
}
404
{
  "error": "project not found"
}

// Project not found
PUT /api/v2/projects/not-found-id
{
  "title": "Modified Sample Project",
  "description": "Modified Description",
  "category": "Modified Category",
  "tags": [
    "Test",
    "Tags",
    "Here"
  ],
  "external_id": "modified_external_id"
}
404
{
  "error": "project not found"
}

// Successful request
PUT /api/v2/projects/JUyeBPY-GcdBEEP5vZrx
{
  "title": "Modified Sample Project",
  "description": "Modified Description",
  "category": "Modified Category",
  "tags": [
    "Test",
    "Tags",
    "Here"
  ],
  "external_id": "modified_external_id"
}
200
{
  "project": {
    "id": "JUyeBPY-GcdBEEP5vZrx",
    "external_id": "modified_external_id",
    "project_id": null,
    "owner": "admin-user-223@example.com",
    "title": "Modified Sample Project",
    "description": "Modified Description",
    "category": "modified category",
    "tags": [
      "test",
      "tags",
      "here"
    ],
    "media_type": "project",
    "isPublic": false,
    "thumbnail_asset_id": null,
    "created_date": "2023-11-27T09:43:25.157Z",
    "modification_date": "2023-11-27T09:43:25.269Z",
    "deleted": null,
    "original_title": "Sample Project"
  }
}

// With invalid parameters
PUT /api/v2/projects/KNfufO5QsfNY-WLbbflv
{
  "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