EXexcalidraw
collections

Update collection

Changed on

Update the metadata of an existing collection by its ID.

You can update the collection name or other editable fields.

**Use cases:**
- Renaming collections
- Managing collections in admin dashboards
- Bulk updating collection metadata
patch/api/v1/collections/{collectionId}

Request

  • Base URL
    https://api.excalidraw.com
  • URL
    https://api.excalidraw.com/api/v1/collections/{collectionId}
  • Auth
    HTTP bearer

Path parameters

collectionIdstring required

Collection ID. Personal API keys may use 'private' for the key owner's virtual private collection. Workspace API keys cannot access private collections.

Request body

namestring required

Response

This response returns the details of the requested collection.

idstring required
isDefaultboolean
workspacestring required
creatorunknown required
updaterunknown
teamsstring[] required
createdstring date-time required
sortOrderunknown
namestring required
updatedstring date-time required
isDeletedboolean
deletedAtnumber

Changes

  • 9fa65a47c84cRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      response property creator list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property sortOrder list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property updater list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      the response's property pattern was changed from ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status

    • info

      the / response's property pattern was changed from ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status