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

Creating a Sprint (V2)

Function

This API is used to create a sprint.

Calling Method

For details, see Calling APIs.

Authorization Information

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

URI

GET /v2/version/create-version

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
start_date	No	Integer	Definition: Start date of the created sprint (in timestamp format, for example, 1754150400000). Constraints: N/A Value range: N/A Default value: N/A
due_date	No	Integer	Definition: End date of the created sprint (in timestamp format, for example, 1754150400000). Constraints: N/A Value range: N/A Default value: N/A
project_id	No	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 N/A Range N/A Default Value N/A
name	No	String	Definition: Name of the sprint to be created. 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	result object	Definition: Result of creating a sprint.
status	String	Definition: Response status of the current sprint. Value range: N/A

**Table 4** result
Parameter	Type	Description
version	version object	Definition: Version information of the created sprint.

**Table 5** version
Parameter	Type	Description
id	Integer	Definition Unique ID of the created sprint. Range N/A
project_num_id	Integer	Definition Unique ID of the project associated with the current sprint. Range N/A
project_id	String	Definition Unique ID of the project to which the current sprint belongs. Range N/A
name	String	Definition: Name of the created sprint. Value range: N/A
due_date	String	Definition: End date of the created sprint. Value range: N/A
effective_date	String	Definition: Effective date of the created sprint. Value range: N/A
status	String	Definition: Status of the current sprint. Value range: 0: not started
sharing	String	Definition: Sharing status of the current sprint. Value range: none: not shared
start_date	String	Definition: Start date of the current sprint. Value range: N/A
done_ratio	Integer	Definition: Progress of the current sprint. Value range: N/A

Example Requests

PUT https://{endpoint}/v2/version/create-version?_=1753067241950

{
  "start_date" : 1752854400000,
  "due_date" : 1754064000000,
  "project_id" : "5192de5eb435430c8cd41c6ae6028848",
  "name" : "test"
}

Example Responses

Status code: 200

{
  "result" : {
    "version" : {
      "id" : 26664721,
      "project_num_id" : 35138974,
      "project_id" : "5192de5eb435430c8cd41c6ae6028848",
      "name" : "Creating a sprint",
      "due_date" : "2025-08-02",
      "effective_date" : "2025-08-02",
      "status" : "0",
      "sharing" : "none",
      "start_date" : "2025-07-19",
      "done_ratio" : 0
    }
  },
  "status" : "success"
}

Status Codes

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

Error Codes

See Error Codes.

Parent topic: Scrum Project Sprints