Update an existing tag
Updates an existing tag name and color. This endpoint allows you to rename tags or change their visual appearance.
What can be updated:
- Tag name: Change the tag label (must be unique within the tag type, case-insensitive)
- Tag color: Set or change the predefined color code for visual organization
How it works:
- Provide the tag ID and new name (required)
- Optionally provide a predefined color code (e.g., “red”, “blue”, “green”)
- The system validates that the new name does not conflict with existing tags
- The system validates that the color is one of the predefined values
- All entities using this tag will automatically reflect the changes
Tag Colors: Tags use predefined color codes, not hex values. Available colors:
default- Light gray (default color)red- Redyellow- Yellowgreen- Greenblue- Bluepurple- Purplefuchsia- Fuchsiapink- Pinkmagenta- Magenta
Use cases:
- Rename tags for better consistency
- Add or change colors for visual organization
- Standardize tag naming across the workspace
Color strategy tips:
- Use green for active processes
- Use blue for customer-related items
- Use red for issues or urgent items
Permission requirements:
- Task tags: Requires Tasks.manageTags permission
- Project tags: Must be an employee (not organization member)
- Project component tags: Requires ProjectComponentsLibrary.edit OR Projects.manageComponents permission
POST
/tags/{type}/saveAuthorization
AuthorizationOAuth2 access token · headerrequiredScopes:
api:writeor
AuthorizationBearer token (JWT) · headerrequiredPath parameters
typestringrequiredThe type of tags to work with. Determines which tag category you are accessing:
- "task": Tags for individual tasks/tickets across all projects
- "project": Tags for categorizing entire projects
- "project-component": Tags used in project component library (with cascading inheritance)
- "organization": Tags for categorizing organizations
- "object": Tags for workspace object instances
- "form-template": Tags for workspace form templates (administration)
Allowed:
taskprojectproject-componentorganizationobjectform-templateQuery parameters
fieldsToReturnstringComma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.
responseShapestringAdvanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.
Allowed:
compactfullHeader parameters
LT-Response-ShapestringAdvanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.
Allowed:
fullRequest body
requiredapplication/jsoncolorstringOptional predefined color code for visual organization of the tag. Must be one of the predefined color values from the palette. Colors help visually distinguish tags in lists and cards. If not provided, the tag will have no color.
**Available color values:**
- `default` - Light gray (default color)
- `red` - Red
- `yellow` - Yellow
- `green` - Green
- `blue` - Blue
- `purple` - Purple
- `fuchsia` - Fuchsia
- `pink` - Pink
- `magenta` - Magenta
Allowed:
defaultredyellowgreenbluepurplefuchsiapinkmagentaidstringrequiredThe unique identifier (UUID) of the tag to update. This identifies which existing tag you want to modify.
namestringrequiredThe new name for the tag. Must be unique within the tag type (case-insensitive). If you change the name, all entities using this tag will automatically reflect the new name.
Responses
200
colorstring | nullrequiredThe predefined color code assigned to the tag for visual organization. Null if no color has been set. Colors help users quickly identify tags in lists and cards.
**Available color values:**
- `default` - Light gray (default color)
- `red` - Red
- `yellow` - Yellow
- `green` - Green
- `blue` - Blue
- `purple` - Purple
- `fuchsia` - Fuchsia
- `pink` - Pink
- `magenta` - Magenta
Allowed:
defaultredyellowgreenbluepurplefuchsiapinkmagentanullidstringrequiredThe unique identifier (UUID) of the tag. Use this ID when updating or deleting the tag.
isDeletedbooleanrequiredIndicates whether the tag has been soft-deleted. Soft-deleted tags are marked as deleted but not permanently removed from the database. They will not appear in list endpoints and are automatically removed from all associated entities.
namestringrequiredThe display name of the tag. This is what users see when the tag is applied to tasks, projects, or components.
400Invalid tag type, duplicate name, or invalid color value
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
404Tag not found
Request
curl -X POST "https://leadtime.app/api/public/tags/task/save" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"color": "blue",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "urgent"
}'const response = await fetch("https://leadtime.app/api/public/tags/task/save", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
},
body: JSON.stringify({
"color": "blue",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "urgent"
})
});import requests
response = requests.post(
"https://leadtime.app/api/public/tags/task/save",
headers={
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
},
json={
"color": "blue",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "urgent"
},
)Response
{
"color": "blue",
"id": "550e8400-e29b-41d4-a716-446655440000",
"isDeleted": false,
"name": "urgent"
}Invalid tag type, duplicate name, or invalid color value
Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions
Tag not found