Breadcrumbs

Metavault API - Update project

UpdateProject - PUT

Path

/api/projects/{projectId}

Http Method

PUT

Overview

NO LICENSE

Update a project’s information.

Required permissions

  • Global administration privileges. ADMIN

Request

Path parameters

Parameter

Type

Required

Description

Example

projectId

string

Yes

The Id of the project, generated on creation.

099ec495a1b548efa43b15da09262c20

Request body

JSON
{
  "displayName": "➳ Project display name",
  "description": "description of the project"
}
Field descriptions

Field

Type

Required

Description

Constraints

displayName

string

No

Name used in the app’s interface.

Must be unique, and must be a maximum of 30 characters long.

description

string

No

Description of the project.

-

Response

The response is equivalent to the project creation: Metavault API - Create project | Response

The only difference is the HTTP response code, which is 200 (Success) instead of 201.