folder

Changed on

Updates a folder's details using its folderID. Currently, you can only update a folder's name.

patch/v1/folders/{folderId}

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/folders/{folderId}
  • Auth: OAuth 2 (authorization code, authorization URL https://www.canva.com/api/oauth/authorize, token URL https://api.canva.com/rest/v1/oauth/token, scopes: folder:write)

Path parameters

folderIdstring required

The folder ID.

Request body

namestring required

The folder name, as shown in the Canva UI.

Example request

{
  "name": "My awesome holiday"
}

Response

OK

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>"
    }
  }
}

Changes

  • 40ca7f6a753bRevision changes
    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

  • 5ea5a3f48e72Revision changes
    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status