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

Updating the Start or End Status of the Current Sprint

Function

This API is used to update the start or end status of the current sprint.

Calling Method

For details, see Calling APIs.

Authorization Information

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

URI

POST /v2/version/state/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
-	No	String	Request body parameters for starting or ending a sprint.
name	No	String	Definition: Name of the current sprint. Constraints: N/A Value range: N/A Default value: N/A
id	No	Integer	Definition: Unique ID of the current sprint. The value is obtained by calling the Querying the Sprint API. The ID in the version field in the response body is the ID of the current sprint. Constraints: N/A Value range: N/A Default value: N/A
project_id	No	String	Definition: 32-character UUID 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 Querying the Project List API. Constraints: N/A Value range: N/A Default value: N/A
status	No	String	Definition: Status of the current project. Constraints: N/A Value range: 0\|1\|2 0: sets the sprint to the unstarted status. 1: starts the current sprint. 2: ends the current sprint. Default value: N/A
due_date	No	String	Definition: End date of the current sprint (in timestamp format, for example, 1839340800000). Constraints: N/A Value range: N/A Default value: N/A
start_date	No	String	Definition: Start date of the current project (in timestamp format, for example, 1839340800000). Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	String	Definition: Returned result of a sprint status. Value range: N/A
status	String	Definition: Status of the current sprint. Value range: success (success) and error (failure)

Example Requests

POST http://{endpoint}/v2/version/state/update

{
  "name" : "333333333",
  "id" : 26658650,
  "project_id" : "ac73924a87d0455ca9b16b0ed15fe367",
  "status" : "0",
  "due_date" : null,
  "start_date" : null
}

Example Responses

Status code: 200

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

Status Codes

Status Code	Description
200	Response to a successful request for updating the start or end status of the current sprint.

Error Codes

See Error Codes.

Parent topic: Project Information