Update custom icon
Updates an existing custom icon by replacing its image.
What can be updated:
- Image only: The icon image can be replaced with a new one
- Name is readonly: The icon name cannot be changed after creation
How to update a custom icon:
- Upload a new image file (PNG or SVG format) using POST /api/public/workspace/upload
- Get the file ID from the upload response
- Use the file ID in the
imageIdfield
Note: This endpoint requires the CustomIcons.create permission. The icon name remains unchanged - only the image is updated. The updated icon will be reflected throughout the workspace wherever it’s used.
PUT
/administration/custom-icons/{id}Authorization
AuthorizationOAuth2 access token · headerrequiredScopes:
api:writeor
AuthorizationBearer token (JWT) · headerrequiredPath parameters
idstringrequiredRequest body
requiredapplication/jsonimageIdstringrequiredFile ID (UUID) of the new icon image. First upload the new image file (PNG or SVG format) using POST /api/public/workspace/upload, then use the returned file ID here. Note: The icon name cannot be changed after creation - only the image can be updated.
Responses
200
Custom icon updated successfully
object401
Unauthorized - Invalid or missing authentication token
403
Forbidden - Insufficient API scopes or permissions