Zur Navigation springen
Projects API

Update Project

Update a project’s name, description, visibility, or mode. Only the fields you provide are changed.

Authentifizierung

x-api-keystring
API-Key-Authentifizierung via Header

Pfadparameter

idstringErforderlich
A unique identifier for a project.

Anfrage

This endpoint expects an object.
namestringOptional
A new name for the project.
descriptionstringOptional
A new description for the project.
visibilityenumOptional
Update who can see the project.
Erlaubte Werte:
modeenumOptional
Update the project mode.
Erlaubte Werte:
defaultWorkflowenumOptional

Update the project's default top-level creator workflow.

Antwort

Project updated successfully
idstring
A unique identifier for a project.
createdAtdatetime
The date and time the project was created.
updatedAtdatetime
The date and time the project was last updated.
visibilityenum
Who can see the project.
Erlaubte Werte:
modeenum
The project mode.
Erlaubte Werte:
namestringOptional
The display name of the project.
descriptionstringOptional
An optional description of the project.
defaultWorkflowenum or nullOptional

The default top-level creator workflow for this project. Null for projects created outside the creator-workflows surface.

Fehler

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error