PlatformProjects

Update a project

View as MarkdownOpen in Claude
Changes the name and security settings of a root project or subproject in the caller's project tree. Use it to control media protection and HTTPS requirements; project API tokens are managed separately through [Project Tokens](/docs/apis/rest/project-tokens/create-token). Compatibility API Accounts use their own SID-based update route. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Management_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
The unique identifier of the project or subproject.

Request

This endpoint expects an object.
namestringOptional<=250 characters
The name of the project.
protect_recordingsbooleanOptional
When enabled, recordings created within the project require authentication to access.
protect_message_mediabooleanOptional
When enabled, message media created within the project requires authentication to access.
protect_fax_mediabooleanOptional
When enabled, fax media created within the project requires authentication to access.
force_https_requestsbooleanOptional
When enabled, requests made to the project's webhooks and callbacks must use HTTPS.

Response

The request has succeeded.
idstringformat: "uuid"
The unique identifier of the project.
namestring
The name of the project.
parent_project_idstring or nullformat: "uuid"

The unique identifier of the root project. null when this project is itself a root project.

subprojectboolean

true when this project is a subproject.

region_preferencestring

The effective region preference for the project. Returned in all responses; it is not currently settable through this API.

protect_recordingsboolean
When enabled, recordings created within the project require authentication to access.
protect_message_mediaboolean
When enabled, message media created within the project requires authentication to access.
protect_fax_mediaboolean
When enabled, fax media created within the project requires authentication to access.
force_https_requestsboolean
When enabled, requests made to the project's webhooks and callbacks must use HTTPS.
created_atdatetime
The date and time when the project was created.
updated_atdatetime
The date and time when the project was last updated.

Errors

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