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.
HTTP method and URL path
PATCH https://api.canva.com /rest /v1 /assets/{assetId}
This operation is rate limited to 30 requests per minute for each user of your integration.
Authentication
This endpoint requires a valid access token that acts on behalf of a user. The token must have the following scopes (permissions):
For more information, see Scopes .
Provides credentials to authenticate the request, in the form of a Bearer
token.
For example: Authorization: Bearer {token}
Indicates the media type of the information sent in the request. This must be set to application/json
.
For example: Content-Type: application/json
Path parameters
Body parameters
The name of the asset. This is shown in the Canva UI.
When this field is undefined, nothing is updated.
Maximum length 50 characters.
Example request
Examples for using the /v1/assets/{assetId}
endpoint:
cURL Node.js Java Python C# Go PHP Ruby
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"
]
}'
const fetch = require ( "node-fetch" ) ;
fetch ( "https://api.canva.com/rest/v1/assets/{assetId}" , {
method : "PATCH" ,
headers : {
"Authorization" : "Bearer {token}" ,
"Content-Type" : "application/json" ,
} ,
body : JSON . stringify ( {
"name" : "My Awesome Upload" ,
"tags" : [
"image" ,
"holiday" ,
"best day ever"
]
} ) ,
} )
. then ( async ( response ) => {
const data = await response . json ( ) ;
console . log ( data ) ;
} )
. catch ( err => console . error ( err ) ) ;
import java . io . IOException ;
import java . net . URI ;
import java . net . http . * ;
public class ApiExample {
public static void main ( String [ ] args ) throws IOException , InterruptedException {
HttpRequest request = HttpRequest . newBuilder ( )
. uri ( URI . create ( "https://api.canva.com/rest/v1/assets/{assetId}" ) )
. header ( "Authorization" , "Bearer {token}" )
. header ( "Content-Type" , "application/json" )
. method ( "PATCH" , HttpRequest . BodyPublishers . ofString ( "{\"name\": \"My Awesome Upload\", \"tags\": [\"image\", \"holiday\", \"best day ever\"]}" ) )
. build ( ) ;
HttpResponse < String > response = HttpClient . newHttpClient ( ) . send (
request ,
HttpResponse . BodyHandlers . ofString ( )
) ;
System . out . println ( response . body ( ) ) ;
}
}
import requests
headers = {
"Authorization" : "Bearer {token}" ,
"Content-Type" : "application/json"
}
data = {
"name" : "My Awesome Upload" ,
"tags" : [
"image" ,
"holiday" ,
"best day ever"
]
}
response = requests . patch ( "https://api.canva.com/rest/v1/assets/{assetId}" ,
headers = headers ,
json = data
)
print ( response . json ( ) )
using System . Net . Http ;
var client = new HttpClient ( ) ;
var request = new HttpRequestMessage
{
Method = HttpMethod . Patch ,
RequestUri = new Uri ( "https://api.canva.com/rest/v1/assets/{assetId}" ) ,
Headers =
{
{ "Authorization" , "Bearer {token}" } ,
} ,
Content = new StringContent (
"{\"name\": \"My Awesome Upload\", \"tags\": [\"image\", \"holiday\", \"best day ever\"]}" ,
Encoding . UTF8 ,
"application/json"
) ,
} ;
using ( var response = await client . SendAsync ( request ) )
{
response . EnsureSuccessStatusCode ( ) ;
var body = await response . Content . ReadAsStringAsync ( ) ;
Console . WriteLine ( body ) ;
} ;
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main ( ) {
payload := strings . NewReader ( `{
"name": "My Awesome Upload",
"tags": [
"image",
"holiday",
"best day ever"
]
}` )
url := "https://api.canva.com/rest/v1/assets/{assetId}"
req , _ := http . NewRequest ( "PATCH" , url , payload )
req . Header . Add ( "Authorization" , "Bearer {token}" )
req . Header . Add ( "Content-Type" , "application/json" )
res , _ := http . DefaultClient . Do ( req )
defer res . Body . Close ( )
body , _ := io . ReadAll ( res . Body )
fmt . Println ( string ( body ) )
}
$curl = curl_init ( ) ;
curl_setopt_array ( $curl , array (
CURLOPT_URL => "https://api.canva.com/rest/v1/assets/{assetId}" ,
CURLOPT_CUSTOMREQUEST => "PATCH" ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_HTTPHEADER => array (
'Authorization: Bearer {token}' ,
'Content-Type: application/json' ,
) ,
CURLOPT_POSTFIELDS => json_encode ( [
"name" => "My Awesome Upload" ,
"tags" => [
"image" ,
"holiday" ,
"best day ever"
]
] )
) ) ;
$response = curl_exec ( $curl ) ;
$err = curl_error ( $curl ) ;
curl_close ( $curl ) ;
if ( empty ( $err ) ) {
echo $response ;
} else {
echo "Error: " . $err ;
}
require 'net/http'
require 'uri'
url = URI ( 'https://api.canva.com/rest/v1/assets/{assetId}' )
http = Net :: HTTP . new ( url . host , url . port )
http . use_ssl = true
request = Net :: HTTP :: Patch . new ( url )
request [ 'Authorization' ] = 'Bearer {token}'
request [ 'Content-Type' ] = 'application/json'
request . body = << REQUEST_BODY
{
"name": "My Awesome Upload",
"tags": [
"image",
"holiday",
"best day ever"
]
}
REQUEST_BODY
response = http . request ( request )
puts response . read_body
Success response
If successful, the endpoint returns a 200
response with a JSON body with the following parameters:
The asset object, which contains metadata about the asset.
Properties of asset
Type of an asset. Currently, this only supports image
assets. Support for video
assets is coming in the future.
When the asset was added to Canva, as a Unix timestamp (in seconds since the Unix
Epoch).
When the asset was last updated in Canva, as a Unix timestamp (in seconds since the
Unix Epoch).
A thumbnail image representing the object.
Properties of thumbnail
The width of the thumbnail image in pixels.
The height of the thumbnail image in pixels.
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.
The import status of the asset.
Properties of import_status
State of the import job for an uploaded asset. This can be one of the following:
failed
in_progress
success
If the import fails, this object provides details about the error.
Properties of error
A human-readable description of what went wrong.
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
Example response
{
"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>"
}
}
}
Try it out