Saltar a la navegación
Projects API

Update Project

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

Autenticación

x-api-keystring
Autenticación con clave API vía encabezado

Parámetros de ruta

idstringRequerido
A unique identifier for a project.

Solicitud

This endpoint expects an object.
namestringOpcional
A new name for the project.
descriptionstringOpcional
A new description for the project.
visibilityenumOpcional
Update who can see the project.
Valores permitidos:
modeenumOpcional
Update the project mode.
Valores permitidos:
defaultWorkflowenumOpcional

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

Respuesta

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.
Valores permitidos:
modeenum
The project mode.
Valores permitidos:
namestringOpcional
The display name of the project.
descriptionstringOpcional
An optional description of the project.
defaultWorkflowenum or nullOpcional

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

Errores

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