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

Updating a Sprint (V2)

Function

This API is used to update a sprint.

Calling Method

For details, see Calling APIs.

Authorization Information

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

URI

POST /v2/version/update

Request Parameters

**Table 1** 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 2** Request body parameters
Parameter	Mandatory	Type	Description
due_date	No	Integer	Definition: End date of the current sprint (in the timestamp format, for example, 1757952000000). Constraints: N/A Value range: N/A Default value: N/A
id	No	Integer	Definition Digital ID of the current sprint. Constraints N/A Range N/A Default Value N/A
name	No	String	Definition: Sprint name after modification. Constraints: N/A Value range: N/A Default value: N/A
start_date	No	Integer	Definition: Start date of the current sprint (in the timestamp format, for example, 1757952000000). Constraints: N/A Value range: N/A Default value: N/A
project_id	No	String	Definition: 32-character ID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the API for querying the project list. Constraints: N/A Value range: N/A Default value: N/A
update_workitem_date	No	Boolean	Definition Whether to change the estimated start and end time of all work items in the sprint. Constraints N/A Range true: Synchronization is required. false: Synchronization is not required. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	String	Definition: Returned result of changing the sprint name. Value range: N/A
status	String	Definition: Returned status of changing a sprint. Value range: success: The modification is successful. error: The modification fails.

Example Requests

POST https://{endpoint}/v2/version/update

{
  "due_date" : 1754064000000,
  "id" : 26664721,
  "name" : "test",
  "start_date" : 1752854400000,
  "project_id" : "5192de5eb435430c8cd41c6ae6028848",
  "update_workitem_date" : false
}

Example Responses

Status code: 200

{
  "result" : "",
  "status" : "success"
}

Status Codes

Status Code	Description
200	OK (The request has succeeded).

Error Codes

See Error Codes.

Parent topic: Scrum Project Sprints