Create custom icon
Creates a new custom icon for the workspace.
What are Custom Icons? Custom icons are user-uploaded symbols (images) that can be used throughout the workspace to visually organize and tag content. They help make information easier to grasp quickly.
How to create a custom icon:
- Upload an image file (PNG or SVG format) using POST /api/public/workspace/upload
- Get the file ID from the upload response
- Provide a unique icon name (e.g.,
:company_logo:,:team_sales:,:lt_editor:) - Use the file ID in the
imageIdfield
Icon name requirements:
- Must be alphanumeric characters and underscores only
- Cannot conflict with default emoji names
- Format: typically wrapped in colons (e.g.,
:icon_name:)
Note: This endpoint requires the CustomIcons.create permission. Once created, the icon is available to all users in the workspace and can be used in projects, tickets, documents, and profiles.
/administration/custom-iconsAuthorizationOAuth2 access token · headerrequiredapi:writeAuthorizationBearer token (JWT) · headerrequiredapplication/jsonimageIdstringrequiredFile ID (UUID) of the uploaded icon image. First upload the image file (PNG or SVG format) using POST /api/public/workspace/upload, then use the returned file ID here.
namestringrequiredUnique name for the custom icon. Must be alphanumeric characters and underscores only. Cannot conflict with default emoji names. Typically formatted with colons (e.g., :company_logo:, :team_sales:, :lt_editor:). This name is used to reference the icon throughout the workspace.
Custom icon created successfully
objectUnauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions