Updates a project. Send a JSON object in the request body in the format {"fieldId":"value"}. For example: {"name":"test-update-by-api"}. Supported fieldId values include name, description, customCode, scope, and custom fields defined for the project.
Endpoint and authorization information
- Get the endpoint: Replace {domain} in the API request syntax.
- Get a personal access token.
|
Product |
Resource |
Required permission |
|
Project Collaboration |
Project |
Read and write |
Request syntax
Region edition
PUT https://{domain}/oapi/v1/projex/projects/{id}Request headers
|
Parameter |
Type |
Required |
Description |
Example value |
|
x-yunxiao-token |
string |
Yes |
Personal access token. |
pt-0fh3****0fbG_35af****0484 |
Request parameters
|
Parameter |
Type |
Location |
Required |
Description |
Example value |
|
id |
string |
path |
Yes |
Unique project identifier. |
589c53d622cc8521793e08**** |
|
- |
object |
body |
No |
Fields to update. |
|
Request examples
Region edition
curl -X 'PUT' \
'https://{domain}/oapi/v1/projex/projects/589c53d622cc8521793e08****' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
}'Response parameters
None
Error codes
For more information, see Error Code Center.