Passer à la navigation
Projects API

Update Project

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

Authentification

x-api-keystring
Authentification par clé API via en-tête

Paramètres de chemin

idstringRequis
A unique identifier for a project.

Requête

This endpoint expects an object.
namestringOptionnel
A new name for the project.
descriptionstringOptionnel
A new description for the project.
visibilityenumOptionnel
Update who can see the project.
Valeurs autorisées:
modeenumOptionnel
Update the project mode.
Valeurs autorisées:
defaultWorkflowenumOptionnel

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

Réponse

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.
Valeurs autorisées:
modeenum
The project mode.
Valeurs autorisées:
namestringOptionnel
The display name of the project.
descriptionstringOptionnel
An optional description of the project.
defaultWorkflowenum or nullOptionnel

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

Erreurs

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