Skip to content
Leadtime
English
Esc
navigateopen⌘Jpreview

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:

  1. Upload an image file (PNG or SVG format) using POST /api/public/workspace/upload
  2. Get the file ID from the upload response
  3. Provide a unique icon name (e.g., :company_logo:, :team_sales:, :lt_editor:)
  4. Use the file ID in the imageId field

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.

POST/administration/custom-icons
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:write
or
AuthorizationBearer token (JWT) · headerrequired
Request body
requiredapplication/json
imageIdstringrequired
File 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.
namestringrequired
Unique 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.
Responses
201Custom icon created successfully
object
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X POST "https://leadtime.app/api/public/administration/custom-icons" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "imageId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "company_logo"
}'
Response
{}