Skip to content

Project.update

Update project fields (title, description, etc.).

Signature

update(**kwargs: Any) -> None

Parameters

Name Type Required Default
**kwargs Any no -

HTTP parameters

Name In Type Required Default
project_id path string yes -

Fields

Schema: ProjectUpdateSchema

Field Type Required
add_from_projects array<string> no
description string no
members array<string> no
slug string no
title string no
visibility string no

Return shape

HTTP 200 — OK

Schema: ProjectSchema

Field Type Required
dataset_count integer no
description string yes
id string yes
prefix string yes
slug string yes
tags array<ProjectTagSchema> no
team_id string yes
title string yes
updated_at string no
visibility string yes

Permission

Required permission: project:update

HTTP

PATCH /api/projects/{id} (updateProject)

Usage

project.update()