PUT /api/v2/assets/:asset_id
Update asset

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

// Successful request
PUT /api/v2/assets/jzEVblfJWkxEReLG4EiF
{
  "title": "Modified Sample Asset",
  "description": "Modified Description",
  "category": "Modified Category",
  "tags": [
    "Test",
    "Tags",
    "Here"
  ],
  "external_id": "modified_external_id"
}
200
{
  "asset": {
    "id": "jzEVblfJWkxEReLG4EiF",
    "external_id": "modified_external_id",
    "parent_id": null,
    "project_id": null,
    "owner": "admin-user-57@example.com",
    "title": "Modified Sample Asset",
    "description": "Modified Description",
    "category": "modified category",
    "tags": [
      "test",
      "tags",
      "here"
    ],
    "ai_tags": [],
    "status": "open",
    "media_type": "placeholder",
    "original_filename": null,
    "drop_folder_id": null,
    "md5_sum": null,
    "created_date": "2023-11-27T09:42:49.451Z",
    "modification_date": "2023-11-27T09:42:49.584Z",
    "deleted": null
  }
}

// Invalid request
PUT /api/v2/assets/not-found-id
{
  "title": "Modified Sample Asset",
  "description": "Modified Description",
  "category": "Modified Category",
  "tags": [
    "Test",
    "Tags",
    "Here"
  ],
  "external_id": "modified_external_id"
}
404
{
  "error": "asset not found"
}

// With invalid parameters
PUT /api/v2/assets/0X24pu3thwNyOx4l9FNY
{
  "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