Skip to main content
PATCH
/
v1
/
projects
/
{project_id}
from retab import Retab

client = Retab()
response = client.projects.update("<project_id>", name="New name")

{
  "id": "<string>",
  "name": "",
  "json_schema": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "sheets_integration": {
    "sheet_id": "<string>",
    "spreadsheet_id": "<string>"
  }
}
from retab import Retab

client = Retab()
response = client.projects.update("<project_id>", name="New name")

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
project_id
string
required

Body

application/json

Enhanced project patch request with conflict detection support.

​
name
string | null

The name of the document

​
json_schema
object | null

The json schema of the project

​
sheets_integration
object | null
​
expected
object | null

Expected baseline state for fields being modified

​
on_conflict
enum<string>
default:raise

How to handle conflicts: 'raise' throws error, 'overwrite' forces update

Available options:
raise,
overwrite

Response

Successful Response

​
id
string
​
name
string
default:""

The name of the project

​
json_schema
object

The json schema of the project

​
updated_at
string<date-time>
​
sheets_integration
object | null