> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 app.

## Authentication and authorization

This endpoint requires a valid access token that acts on behalf of a user. For more information, see [Generate an access token](/docs/apps/rest-apis/reference/authentication/generate-access-token).

### Scopes

The access token must have all the following [scopes](/docs/apps/rest-apis/scopes) (permissions):

* `asset:write`

## Header parameters

<Prop.List>
  <Prop name="Authorization" type="string" required>
    Provides credentials to authenticate the request, in the form of a `Bearer` token.

    For example: `Authorization: Bearer {token}`
  </Prop>

  <Prop name="Content-Type" type="string" 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`
  </Prop>
</Prop.List>

## Path parameters

<Prop.List>
  <Prop name="assetId" type="string" required>
    The ID of the asset.
  </Prop>
</Prop.List>

## Body parameters

<Prop.List>
  <Prop name="name" type="string">
    The name of the asset. This is shown in the Canva UI.
    When this field is undefined or empty, nothing is updated.

    <Prop.Extras>
      **Maximum length:** `50`
    </Prop.Extras>
  </Prop>

  <Prop name="tags" type="string[]">
    The replacement tags for the asset.
    When this field is undefined, nothing is updated.

    <Prop.Extras>
      **Maximum items:** `50`
    </Prop.Extras>
  </Prop>
</Prop.List>

## Example request

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

<Tabs storageKey="example.language" disableContentTransition>
  <Tab name="cURL">
    ```sh
    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"
      ]
    }'
    ```
  </Tab>

  <Tab name="Node.js">
    ```js
    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));
    ```
  </Tab>

  <Tab name="Java">
    ```java
    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());
        }
    }
    ```
  </Tab>

  <Tab name="Python">
    ```py
    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())
    ```
  </Tab>

  <Tab name="C#">
    ```csharp
    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);
    };
    ```
  </Tab>

  <Tab name="Go">
    ```go
    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))
    }
    ```
  </Tab>

  <Tab name="PHP">
    ```php
    $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;
    }
    ```
  </Tab>

  <Tab name="Ruby">
    ```ruby
    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
    ```
  </Tab>
</Tabs>

## Success response

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

<Prop.List>
  <Prop name="asset" type="Asset" required mode="output">
    The asset object, which contains metadata about the asset.

    <PillAccordion title={<>Properties of <strong>asset</strong></>} defaultExpanded={true}>
      <Prop.List>
        <Prop name="type" type="string" required mode="output">
          Type of an asset.

          <Prop.Extras>
            **Available values:**

            * `image`
            * `video`
          </Prop.Extras>
        </Prop>

        <Prop name="id" type="string" required mode="output">
          The ID of the asset.
        </Prop>

        <Prop name="name" type="string" required mode="output">
          The name of the asset.
        </Prop>

        <Prop name="tags" type="string[]" required mode="output">
          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](https://www.canva.com/help/add-edit-tags/).
        </Prop>

        <Prop name="created_at" type="integer" required mode="output">
          When the asset was added to Canva, as a Unix timestamp (in seconds since the Unix
          Epoch).
        </Prop>

        <Prop name="updated_at" type="integer" required mode="output">
          When the asset was last updated in Canva, as a Unix timestamp (in seconds since the
          Unix Epoch).
        </Prop>

        <Prop name="owner" type="TeamUserSummary" required mode="output">
          Metadata for the user, consisting of the User ID and Team ID.

          <PillAccordion title={<>Properties of <strong>owner</strong></>}>
            <Prop.List>
              <Prop name="user_id" type="string" required mode="output">
                The ID of the user.
              </Prop>

              <Prop name="team_id" type="string" required mode="output">
                The ID of the user's Canva Team.
              </Prop>
            </Prop.List>
          </PillAccordion>
        </Prop>

        <Prop name="thumbnail" type="Thumbnail" mode="output">
          A thumbnail image representing the object.

          <PillAccordion title={<>Properties of <strong>thumbnail</strong></>}>
            <Prop.List>
              <Prop name="width" type="integer" required mode="output">
                The width of the thumbnail image in pixels.
              </Prop>

              <Prop name="height" type="integer" required mode="output">
                The height of the thumbnail image in pixels.
              </Prop>

              <Prop name="url" type="string" required mode="output">
                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.
              </Prop>
            </Prop.List>
          </PillAccordion>
        </Prop>

        <Prop name="metadata" type="AssetMetadata" mode="output">
          Type-specific metadata for the asset.

          <Tabs>
            <Tab name="image">
              <Prop.List>
                <Prop name="type" type="string" required mode="output">
                  <Prop.Extras>
                    **Available values:** The only valid value is `image`.
                  </Prop.Extras>
                </Prop>

                <Prop name="width" type="integer" mode="output">
                  The width of the image in pixels.
                </Prop>

                <Prop name="height" type="integer" mode="output">
                  The height of the image in pixels.
                </Prop>

                <Prop name="smart_tags" type="string[]" mode="output">
                  AI-generated tags for the image.
                </Prop>
              </Prop.List>
            </Tab>

            <Tab name="video">
              <Prop.List>
                <Prop name="type" type="string" required mode="output">
                  <Prop.Extras>
                    **Available values:** The only valid value is `video`.
                  </Prop.Extras>
                </Prop>

                <Prop name="width" type="integer" required mode="output">
                  The width of the video in pixels.
                </Prop>

                <Prop name="height" type="integer" required mode="output">
                  The height of the video in pixels.
                </Prop>

                <Prop name="duration" type="integer" mode="output">
                  The duration of the video in seconds.
                </Prop>
              </Prop.List>
            </Tab>
          </Tabs>
        </Prop>

        <Prop name="import_status" type="ImportStatus" deprecated mode="output">
          The import status of the asset.

          <PillAccordion title={<>Properties of <strong>import_status</strong></>}>
            <Prop.List>
              <Prop name="state" type="string" required deprecated mode="output">
                State of the import job for an uploaded asset.

                <Prop.Extras>
                  **Available values:**

                  * `failed`
                  * `in_progress`
                  * `success`
                </Prop.Extras>
              </Prop>

              <Prop name="error" type="ImportError" deprecated mode="output">
                If the import fails, this object provides details about the error.

                <PillAccordion title={<>Properties of <strong>error</strong></>}>
                  <Prop.List>
                    <Prop name="message" type="string" required deprecated mode="output">
                      A human-readable description of what went wrong.
                    </Prop>

                    <Prop name="code" type="string" required deprecated mode="output">
                      A short string indicating why the upload failed. This field can be used to handle errors programmatically.

                      <Prop.Extras>
                        **Available values:**

                        * `file_too_big`
                        * `import_failed`
                      </Prop.Extras>
                    </Prop>
                  </Prop.List>
                </PillAccordion>
              </Prop>
            </Prop.List>
          </PillAccordion>
        </Prop>
      </Prop.List>
    </PillAccordion>
  </Prop>
</Prop.List>

## Example response

```json
{
  "asset": {
    "type": "image",
    "id": "Msd59349ff",
    "name": "My Awesome Upload",
    "tags": [
      "image",
      "holiday",
      "best day ever"
    ],
    "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": {
      "type": "image",
      "width": 1920,
      "height": 1080,
      "smart_tags": [
        "landscape",
        "sunset",
        "mountains",
        "nature"
      ]
    }
  }
}
```

## Error responses

### 403 Forbidden

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error response

##### Not allowed to update the asset

```json
{
  "code": "permission_denied",
  "message": "Not allowed to update this asset"
}
```

### 404 Not Found

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error response

##### The asset was not found

```json
{
  "code": "asset_not_found",
  "message": "Asset not found"
}
```