API ReferenceProjects

Update

Updates a project by name or ID.

Authentication

AuthorizationBearer
Bearer authentication header of the form `Bearer <PHONIC_API_KEY>`. Manage your API keys [here](https://phonic.co/api-keys).

Path parameters

nameOrIdstringRequired
The name or the ID of the project to update.

Request

This endpoint expects an object.
namestringOptional
The name of the project. Can only contain lowercase letters, numbers and hyphens. Must be unique within the workspace.
default_agentstring or nullOptional

The name of the new project’s default agent. Set to null to remove the default agent.

Response

Success response
successboolean
Whether the project was updated successfully.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error