Help Center/ CodeArts Req/ API Reference/ API/ IPD Tag Management/ Updating a Tag
Updated on 2026-05-19 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Updating a Tag

Function

This API is used to update a tag. The title and color can be updated.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/ipdprojectservice/projects/{project_id}/tags/{label_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

32-character ID of a project, which must be unique.

Obtain the value by calling the Querying the IPD Project List API. The value of id in the response message body is the project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

label_id

Yes

String

Definition:

Label ID, which uniquely identifies a label.

It is the value of id in the response body returned by calling the Querying the Label List API.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

color

Yes

String

Tag color, which is optional when used as an update parameter. Available color codes: #86CAFF, #6DDEBB, #A6DD82, #FAC20A,

#FA9841, #F66F6A, #F3689A, #A97AF8, #71757F, #5E7CE0, #207AB3, #169E6C, #6CA83B, #B58200,

#B54E04, #B02121, #AD215B, #572DB3, #4F4F4F, and "#3C51A6".

title

Yes

String

Tag title, which can contain a maximum of 30 characters. It is optional when used as an update parameter.

label_type

No

String

Definition:

Work item type of a tag. Use commas (,) to separate multiple values.

Constraints:

N/A

Value range:

feature

raw requirement

requirement (R&D requirement)

task

bug

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Returned status.

Value range:

success: The response is successful.

error: The response failed.

message

String

Response.

result

Array of LabelUpdateResult objects

Label details.
Table 4 LabelUpdateResult

Parameter

Type

Description

label_type

String

Definition:

Work item type of a tag. Use commas (,) to separate multiple values.

Constraints:

N/A

Value range:

feature

raw requirement

requirement (R&D requirement)

task

bug

Default value:

N/A

color

String

Definition:

Label RGB color.

Constraints:

Minimum length: 0 characters. Maximum length: 16 characters.

Value range:

N/A

Default value:

N/A

title

String

Definition:

Label title.

Constraints:

Minimum length: 2 characters. Maximum length: 256 characters.

Value range:

N/A

Default value:

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error description, which is a supplement to error_code.

Value range:

N/A

Example Requests

Updating the tag title

https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/tags/1030868827803529217

{
  "title" : "Tag-RR-01",
  "color" : "#A6DD82",
  "label_type" : "requirement"
}

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "message" : "ok",
  "result" : {
    "color" : "#A6DD82",
    "title" : "Tag-RR-01",
    "label_type" : "requirement"
  }
}

Status code: 400

Response upon a request failure. For example, the user does not have the operation permission or the project does not exist.

{
  "error_code" : "PM.02174103",
  "error_msg" : "No permission."
}

Status Codes

Status Code

Description

200

OK

400

Response upon a request failure. For example, the user does not have the operation permission or the project does not exist.

Error Codes

See Error Codes.

Parent topic: IPD Tag Management