Bundles / Update

Update Bundle

Modify a bundle's name, color, icon, or description. Changes take effect immediately. Note that updating a bundle does not affect the seeds contained within it.

PATCH {baseAPIUrl}/bundles/:bundleId

Authentication

Required. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Path Parameters

ParameterTypeDescription
bundleIdstringUUID of the bundle to update

Query Parameters

ParameterTypeRequiredDescription
appIdstringRequiredApplication identifier
externalUserIdstringRequiredExternal user identifier

Request Body

FieldTypeRequiredDescription
namestringOptionalUpdated name (1-100 chars)
colorstringOptionalUpdated hex color code
iconstringOptionalUpdated icon name
descriptionstringOptionalUpdated description (max 500 chars)

Response

FieldTypeDescription
idstringBundle identifier
namestringUpdated bundle name
colorstringUpdated hex color code
updatedAtstringISO 8601 timestamp of last update

Try It

Path Parameters

UUID of the bundle to update

Query Parameters

Application identifier for multi-tenant isolation

External user identifier for data isolation

Request Body

Updated bundle name (1-100 characters)

Updated hex color code

Updated icon name (e.g., folder, book)

Updated description (max 500 characters)