Gamma API
ProjectsProjects

Update a project

PATCH
/api/projects/{projectId}

Absent fields are left alone; description: null clears it. The conversion options apply to uploads from then on. The name and the description are the organization's to change: a project admin who is not an owner or admin of the organization gets 403 for either.

Who may call it: Whoever manages the project: an owner, security admin or admin of its organization, or an admin of the project. API keys: no.

Authorization

session
cookiegamma.session_token<token>

The session cookie a sign-in sets. Over HTTPS its name carries the __Secure- prefix. Browsers send it on their own; other clients keep it from the sign-in response.

Path Parameters

projectId*string

The project's id.

Request Body

application/json
  1. body
name?string
Length1 <= length <= 200
description?|null
status?string
Value in"active""archived"
process2dContent?boolean
useMaterialColors?boolean

Response Body

OK.

application/json
  1. response
project*
Example Request
curl -X PATCH 'http://localhost:3000/api/projects/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "project": {    "id": "string",    "organizationId": "string",    "organizationSlug": "string",    "organizationName": "string",    "name": "string",    "description": "string",    "status": "active",    "process2dContent": true,    "useMaterialColors": true,    "memberCount": -9007199254740991,    "modelCount": -9007199254740991,    "issueCount": -9007199254740991,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "deletedAt": "2019-08-24T14:15:22Z",    "purgeAt": "2019-08-24T14:15:22Z"  }}