Update asset

Update the metadata for an asset in the users Projects.

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 https://api.canva.com/rest/v1/assets/{assetId}

This endpoint requires a valid access token that acts on behalf of a user. The token must have the following scopes (permissions):

  • asset:write

For more information, see Scopes.

#Authorizationstring
Required

Provides credentials to authenticate the request, in the form of a Bearer token.

For example: Authorization: Bearer {token}

#Content-Typestring
Required

Indicates the media type of the information sent in the request. This must be set to application/json.

For example: Content-Type: application/json

#assetIdstring
Required

The ID of the asset.

#namestring
Optional

The name of the asset. This is shown in the Canva UI. When this field is undefined, nothing is updated. Maximum length 50 characters.

#tagsstring[]
Optional

The replacement tags for the asset. When this field is undefined, nothing is updated. Maximum length 50 tags. Each tag has a maximum length of 50 characters.

Examples for using the /v1/assets/{assetId} endpoint:

curl --request PATCH 'https://api.canva.com/rest/v1/assets/{assetId}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"name": "My Awesome Upload",
"tags": [
"image",
"holiday",
"best day ever"
]
}'
sh

If successful, the endpoint returns a 200 response with a JSON body with the following parameters:

#assetAsset

The asset object, which contains metadata about the asset.

Properties of asset
#typestring

Type of an asset. The value for this can only be image.

#idstring

The ID of the asset.

#namestring

The name of the asset.

#tagsstring[]

The user-facing tags attached to the asset. Users can add these tags to their uploaded assets, and they can search their uploaded assets in the Canva UI by searching for these tags. For information on how users use tags, see the Canva Help Center page on asset tags.

#created_atinteger

When the asset was added to Canva, as a Unix timestamp (in seconds since the Unix Epoch).

#updated_atinteger

When the asset was last updated in Canva, as a Unix timestamp (in seconds since the Unix Epoch).

#thumbnailThumbnail
Optional

A thumbnail image representing the object.

Properties of thumbnail
#widthinteger

The width of the thumbnail image in pixels.

#heightinteger

The height of the thumbnail image in pixels.

#urlstring

A URL for retrieving the thumbnail image. This URL expires after 15 minutes. This URL includes a query string that's required for retrieving the thumbnail.

#import_statusImportStatus
Deprecated

The import status of the asset.

Properties of import_status
#statestring

State of the import job for an uploaded asset. This can be one of the following:

  • failed
  • in_progress
  • success
#errorImportError
Deprecated

If the import fails, this object provides details about the error.

Properties of error
#messagestring

A human-readable description of what went wrong.

#codestring

A short string indicating why the upload failed. This field can be used to handle errors programmatically. This can be one of the following:

  • file_too_big
  • import_failed
{
"asset": {
"type": "image",
"id": "Msd59349ff",
"name": "My Awesome Upload",
"tags": [
"image",
"holiday",
"best day ever"
],
"created_at": 1377396000,
"updated_at": 1692928800,
"thumbnail": {
"width": 595,
"height": 335,
"url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
}
}
}
json

To get started, generate an access token or provide your own below