PATCH
Update a project

Authorizations

Authorization
string
header
required

Your Gwenlake API key, sent as Authorization: Bearer <key>.

Headers

x-user
string | null

Path Parameters

project_id
string
required

Body

application/json

PATCH payload — like ResourceBase but every field is optional, so the slug can be changed on its own (ResourceBase requires name, which makes a slug-only update impossible). When a name is sent without a slug, the slug is still regenerated from it (same rule as create/rename); sending only slug (or the legacy alias) updates the slug and leaves the name untouched.

name
string | null
slug
string | null
alias
string | null
description
string | null
picture
string | null
organization_id
string | null
parent_id
string | null

Response

Successful Response

id
string
required
name
string
required
object
string
default:project
slug
string | null
alias
string | null
storage_path
string | null
description
string | null
picture
string | null
organization_id
string | null
project_id
string | null
parent_id
string | null
created_by
string | null
created_at
string<date-time> | null
updated_at
string<date-time> | null