Update project attributes such as name, description, status, project type, and participants.
The number in the URL path (/1/
) is the organization identifier β referred to as account_id
.
This value must match the account associated with the provided session_id
.
This endpoint supports both:
POST https://api.doboard.com/42/project_update
Body:
{
"session_id": "abc123xyz",
"project_id": 77,
"name": "Updated Website Redesign",
"status": "ARCHIVE"
}
In this example:
42
is the organization/account IDsession_id=abc123xyz
is used for authentication77
will have its name changed and archivedIf the account ID in the URL does not match the one tied to the session, the request will be rejected.
Required
The method is available to users with the following roles:
ADMIN
PROJECT_MANAGER
REGULAR
GUEST
users roles are not allowed.
Authentication is performed using a valid session_id.
Public access via token is not supported.
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
session_id |
string |
Yes | β | Authenticated user session ID |
project_id |
int |
Yes | β | ID of the project to be updated |
name |
string |
Optional | β | Project name (max 128 characters) |
description |
string |
Optional | β | Optional project description (max 1024 characters) |
project_type |
string |
Optional | β | Project type: REGULAR or PUBLIC |
auto_close_track |
int |
Optional | β | Automatically closes boards inside the project when there are no open tasks (1 = enabled, 0 = disabled) |
status |
string |
Optional | β | Status: one of ACTIVE , ARCHIVE , TEMPLATE , REMOVED |
hostname |
string |
Optional | β | Optional domain name |
user_ids |
array[int] |
Optional | β | List of user IDs to assign to the project |
favorite |
bool (1 /0 ) |
Optional | β | Toggle project favorite status for current user |
On success, the API returns the updated project ID:
{
"data": {
"operation_status": "SUCCESS",
"project_id": 77
}
}
HTTP Code | error_no |
Message | Description |
---|---|---|---|
401 |
β | Unauthorized |
Missing or invalid session_id |
200 |
3501 |
project_id is required |
No project ID was provided |
200 |
3502 |
Project Not Found |
No project found with given ID |
200 |
3503 |
name is required |
name is set but empty |
200 |
3504 |
status must be in ('ACTIVE','ARCHIVE','REMOVED','TEMPLATE') |
Invalid status value |
200 |
3505 |
Empty input |
No update fields were provided |
200 |
3506 |
project_type must be in ('REGULAR','PUBLIC') |
Invalid project type |
500 |
0 |
Internal API Error |
Internal error |
Role | Access |
---|---|
ADMIN |
β Yes |
PROJECT_MANAGER |
β Yes |
REGULAR |
β Yes |
GUEST |
β No |