Updated on 2026-10-27 GMT+08:00

Updating a Thumbnail

Function

This API is used to update a thumbnail.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

PUT /v3/plan/{project_id}/management/{plan_id}/img

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID. Constraints A string of 32 characters consisting of letters and digits. Range N/A Default Value N/A
plan_id	Yes	String	Definition Unique ID of a release or sprint. You can obtain the release/sprint ID using the Obtaining the Sprint List of a Specified Project API. The value of the id field in the response message body is the release/sprint ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range The value contains 10 to 32,768 characters. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
img_url	Yes	String	Definition Thumbnail URL. Constraints Image URI, in the format of /v1/upload/{placeholder}/{6-digit number}/{file name}.{extension}. Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	result object	Definition: Plan list.
status	String	Definition: Processing status of a request. Value range: success error: failed

**Table 5** result
Parameter	Type	Description
id	String	Definition Plan ID. Range N/A
name	String	Definition: Plan title. Value range: N/A
type	String	Definition: Plan type. Value range: gantt (Gantt chart) mind (mind map)
project_id	String	Definition ID of the project to which the plan belongs. Range N/A
img_url	String	Definition: Address for storing images. Value range: N/A
creator	creator object	Definition: Creator information.

**Table 6** creator
Parameter	Type	Description
user_id	String	Definition User ID of the creator. Range N/A
domain_id	String	Definition Tenant ID. Range N/A
nick_name	String	Definition: Creator alias. Value range: N/A
first_name	String	Definition: Username of the creator. Value range: N/A

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error description, which is a supplement to error_code. Range N/A

Example Requests

PUT https://{endpoint}/v3/plan/919bb351ef424e2daaf3dd80c179fae9/management/bf56512ab4e544c29d03d068711ca56a/img

{
  "img_url" : "/v1/upload/919bb351ef424e2daaf3dd80c179fae9/202506/1749730526922581391.png"
}

Example Responses