Tolgee Octri Demo
PUT/v2/projects/{projectId}/labels/{labelId}

Update a project label

Replaces a project label's name, color, and description. Supply the required name and color; you can omit description if you do not want to set one. The response contains the updated label.

2 parameters · 3 body fields
labelIdintegerrequired
The unique integer identifier of the label to update.
projectIdintegerrequired
The unique integer identifier of the project containing the label.

The label values to replace. Include name and color; description is optional.

colorstringrequired
Hex color in format #RRGGBB.
descriptionstringoptional
A description of the label. Maximum 2000 characters.
namestringrequired
The label name. Maximum 100 characters.

5 status codes
200Returns the updated label with its `id`, `name`, `color`, and optional `description`.
colorstringrequired
descriptionstringoptional
idintegerrequired
namestringrequired
400Returned when the request body is invalid, including when required fields are missing or field values fail validation.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when you do not have permission to update the label.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project or label is not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid, a 401 when authentication is missing or invalid, a 403 when you lack permission, and a 404 when the project or label is not found. The labelId path parameter and projectId path parameter must identify an existing label and project. The body must include name and color; name can contain at most 100 characters, color must match the #RRGGBB hex format, and description can contain at most 2000 characters.