Skip to main content
PATCH
When using this endpoint, keep in mind that:
  • All changes succeed or fail together. No partial updates occur.
  • Label matching is case-insensitive.
  • Requests must have at least one operation. Either add or remove must contain at least one label.
  • Labels must already exist to be added to or removed from a folder. Create labels with the Create label API.
  • Labels cannot be included in both add and remove in the same request.
  • Organization Admin permissions are required to add or remove Verified or Homepage labels

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

folderId
string<uuid>
required

The folder identifier (UUID). Use the List folders endpoint to retrieve folder IDs.

Query Parameters

userId
string

Requires an Organization API key. Optional user ID that attributes the action to the specified user.

Body

application/json
add
string[]

Label names to add to the folder

Required string length: 2 - 25
remove
string[]

Label names to remove from the folder

Required string length: 2 - 25

Response

Labels updated successfully

labels
string[]

The updated list of labels on the folder