Edit

[POST] .../v1/project/edit

Edits project parameters. Update editable project properties such as name, description, logo, responsible user or access lists. The method modifies an existing non-deleted project and returns UpdateResult with the number of affected rows. The request body must contain a valid project id, the caller needs project edit permission and missing body, invalid id, denied access, missing project, storage errors or validation errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
access_all Boolean Optional Public access flag.
access_group_ids Array of Int64 Optional New list of groups with access.
access_user_ids Array of Int64 Optional New list of users with access.
description String Optional New project description.
id Int64 Required Project ID.
logo_file_id Int64 Optional New logo file ID. Pass 0 to clear it.
name String Optional New project name.
responsible_user_id Int64 Optional New responsible user.

Request Example

{
  "id": 10,
  "name": "New store launch",
  "description": "Updated project scope.",
  "responsible_user_id": 18
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}