Update folder
Updates a folder's details using its folderID.
Currently, you can only update a folder's name.
HTTP method and URL path
https://api.canva.com /rest /v1 /folders/{folderId}This operation is rate limited to 20 requests per minute for each user of your integration.
Authentication and authorization
This endpoint requires a valid access token that acts on behalf of a user.
Scopes
The access token must have all the following scopes (permissions):
folder:write
Header parameters
Content-TypestringIndicates 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
folderIdstringThe folder ID.
Body parameters
namestringThe folder name, as shown in the Canva UI.
Minimum length: 1
Maximum length: 255
Example request
Examples for using the /v1/folders/{folderId} endpoint:
curl --request PATCH 'https://api.canva.com/rest/v1/folders/{folderId}' \--header 'Authorization: Bearer {token}' \--header 'Content-Type: application/json' \--data '{"name": "My awesome holiday"}'
const fetch = require("node-fetch");fetch("https://api.canva.com/rest/v1/folders/{folderId}", {method: "PATCH",headers: {"Authorization": "Bearer {token}","Content-Type": "application/json",},body: JSON.stringify({"name": "My awesome holiday"}),}).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/folders/{folderId}")).header("Authorization", "Bearer {token}").header("Content-Type", "application/json").method("PATCH", HttpRequest.BodyPublishers.ofString("{\"name\": \"My awesome holiday\"}")).build();HttpResponse<String> response = HttpClient.newHttpClient().send(request,HttpResponse.BodyHandlers.ofString());System.out.println(response.body());}}
import requestsheaders = {"Authorization": "Bearer {token}","Content-Type": "application/json"}data = {"name": "My awesome holiday"}response = requests.patch("https://api.canva.com/rest/v1/folders/{folderId}",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/folders/{folderId}"),Headers ={{ "Authorization", "Bearer {token}" },},Content = new StringContent("{\"name\": \"My awesome holiday\"}",Encoding.UTF8,"application/json"),};using (var response = await client.SendAsync(request)){response.EnsureSuccessStatusCode();var body = await response.Content.ReadAsStringAsync();Console.WriteLine(body);};
package mainimport ("fmt""io""net/http""strings")func main() {payload := strings.NewReader(`{"name": "My awesome holiday"}`)url := "https://api.canva.com/rest/v1/folders/{folderId}"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/folders/{folderId}",CURLOPT_CUSTOMREQUEST => "PATCH",CURLOPT_RETURNTRANSFER => true,CURLOPT_HTTPHEADER => array('Authorization: Bearer {token}','Content-Type: application/json',),CURLOPT_POSTFIELDS => json_encode(["name" => "My awesome holiday"])));$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/folders/{folderId}')http = Net::HTTP.new(url.host, url.port)http.use_ssl = truerequest = Net::HTTP::Patch.new(url)request['Authorization'] = 'Bearer {token}'request['Content-Type'] = 'application/json'request.body = <<REQUEST_BODY{"name": "My awesome holiday"}REQUEST_BODYresponse = 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:
folderFolderThe folder object, which contains metadata about the folder.
idstringThe folder ID.
namestringThe folder name.
created_atintegerWhen the folder was created, as a Unix timestamp (in seconds since the Unix Epoch).
updated_atintegerWhen the folder was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
thumbnailThumbnailA thumbnail image representing the object.
widthintegerThe width of the thumbnail image in pixels.
heightintegerThe height of the thumbnail image in pixels.
urlstringA 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.
Example response
{"folder": {"id": "FAF2lZtloor","name": "My awesome holiday","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>"}}}