Updated on 2025-05-22 GMT+08:00

Creating a Project

Function

Creating a Project

URI

POST /v4/project

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Minimum: 10

Maximum: 32768

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

project_name

Yes

String

Project

Minimum: 1

Maximum: 128

description

No

String

Description

source

No

String

Project Source

project_type

Yes

String

Project type: scrum, xboard (Kanban project), basic, phoenix (Phoenix project)

enterprise_id

No

String

Specifies the ID of the enterprise project to be bound to the project.

template_id

No

Integer

ID of the project template created by the user.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

project_num_id

Integer

Project ID

project_id

String

Project ID

Minimum: 32

Maximum: 32

project_name

String

Project name

Minimum: 1

Maximum: 128

description

String

Description

project_type

String

Project Type

user_num_id

Integer

Creator ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Example Requests

Post https://{endpoint}/v4/project

{
  "project_name" : "TestDemo",
  "description" : "modify testxxxxx",
  "project_type" : "scrum"
}

Example Responses

Status code: 200

OK

{
  "project_num_id" : 708168641,
  "project_name" : "testdemo",
  "project_id" : "2e76d6f0b2c5403796e36bf63c5d5561",
  "user_num_id" : 700145037,
  "project_type" : "scrum",
  "description" : "this is demo"
}

Status code: 400

Bad Request

{
  "error_msg" : "param error",
  "error_code" : "PM.00000001"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more