v1Resources/Data/patchUpdate a folder

Update a folder

Renames a folder or edits its description or scope.

patch/api/v1/folders/{id}
media:write
Query parameters
idstringrequired
The folder to update.
Request body
namestringoptional
New name.
descriptionstringoptional
New description, or null to clear it.
scopeTypestring (account | client | location | brand)optional
New scope type: account, client, location, or brand.
scopeIdstringoptional
The id for scopeType, when given.
Response
dataobjectoptional
folderobjectoptional
idstringoptional
Unique identifier for the folder.
namestringoptional
The folder's name.
descriptionstringoptional
The folder's description, or null.
itemCountnumberoptional
Number of assets currently in the folder.
sourceMixarray of stringoptional
The distinct asset sources present in the folder.
scopeobjectoptional
The folder's scope, or null when it's agency-wide.
typestring (account | client | location | brand)optional
idstringoptional
sharingobjectoptional
The folder's public-sharing state.
accessstring (restricted | link)optional
urlstringoptional
createdAtstringoptional
When the folder was created, as an ISO 8601 timestamp.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
patch/api/v1/folders/{id}
Your API key
id *
Request body
{
  "data": {
    "folder": {
      "id": "folder_1",
      "name": "Storefront Photos (2026)",
      "description": "Current-season storefront shots",
      "itemCount": 12,
      "sourceMix": [
        "upload",
        "gmb"
      ],
      "scope": {
        "type": "client",
        "id": "cli_123"
      },
      "sharing": {
        "access": "restricted",
        "url": null
      },
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  }
}