PATCH /v1/assets/:assetId — canva-connect-api

v3

asset

You can update the name and tags of an asset by specifying its assetId. Updating the tags replaces all existing tags of the asset.

patch/v1/assets/{assetId}

Path parameters

assetIdstring required

The ID of the asset.

Request body

namestring

The name of the asset. This is shown in the Canva UI. When this field is undefined or empty, nothing is updated.

tagsstring[]

The replacement tags for the asset. When this field is undefined, nothing is updated.

Example request

{
  "name": "My Awesome Upload",
  "tags": [
    "image",
    "holiday",
    "best day ever"
  ]
}

Response

Example response

{
  "asset": {
    "type": "image",
    "id": "Msd59349ff",
    "name": "My Awesome Upload",
    "tags": [
      "image",
      "holiday",
      "best day ever"
    ],
    "import_status": {
      "state": "success"
    },
    "created_at": 1377396000,
    "updated_at": 1692928800,
    "owner": {
      "user_id": "auDAbliZ2rQNNOsUl5OLu",
      "team_id": "Oi2RJILTrKk0KRhRUZozX"
    },
    "thumbnail": {
      "width": 595,
      "height": 335,
      "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
    },
    "metadata": {
      "width": 1920,
      "height": 1080,
      "smart_tags": [
        "landscape",
        "sunset",
        "mountains",
        "nature"
      ]
    }
  }
}