Sign in
Projects

Update a project

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. 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.

patch/api/projects/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

The unique identifier of the project or subproject.

Request body

namestring

The name of the project.

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.

Example request

{
  "name": "Acme Staging (EU)",
  "protect_recordings": true,
  "protect_message_media": true,
  "force_https_requests": true
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring required

The name of the project.

parent_project_idstring uuid required

Universal Unique Identifier.

subprojectboolean required

true when this project is a subproject.

region_preferencestring required

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

protect_recordingsboolean required

When enabled, recordings created within the project require authentication to access.

protect_message_mediaboolean required

When enabled, message media created within the project requires authentication to access.

protect_fax_mediaboolean required

When enabled, fax media created within the project requires authentication to access.

force_https_requestsboolean required

When enabled, requests made to the project's webhooks and callbacks must use HTTPS.

created_atstring date-time required

The date and time when the project was created.

updated_atstring date-time required

The date and time when the project was last updated.

Example response

{
  "name": "Acme Staging",
  "subproject": true,
  "region_preference": "us-west",
  "force_https_requests": true,
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z"
}

Changes

Changed in 2 of the 137 revisions of this API.3

Of the 137 revisions, 3 have a changelog that could not be searched.