Sign in
Projects

Create a subproject

Creates a subproject under the authenticated root project.

Creating a project is only allowed when authenticated as a top-level (root) project. A subproject cannot itself contain subprojects, so attempting to create one while authenticated as a subproject fails with 422 nested_subprojects_not_allowed.

The response includes the signing_key. This is the only time it is returned — it cannot be retrieved through the API afterward, so capture it from this response.

Use a subproject to isolate settings and resources beneath a root project. Integrations built around Compatibility API Account SIDs can use Create subprojects instead.

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.

post/api/projects

Request body

namestring required

The name of the subproject.

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",
  "protect_recordings": true,
  "force_https_requests": true
}

Response

The request has succeeded and a new resource has been created as a result.

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.

signing_keystring required

The project's signing key. Only returned on create and signing-key rotation responses; it cannot be retrieved through the API afterward.

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",
  "signing_key": "PSK_4d8c2b1a9f3e7c6d5b4a3e2f1d0c9b8a"
}

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.