Create Subprojects

View as MarkdownOpen in Claude
This endpoint creates a subproject on the Project you are connecting as. #### 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) ```

Request

This endpoint expects an object.
FriendlyNamestringRequired<=250 characters
The name of the Project, up to 250 characters long.

Response

Response containing a newly created subproject account.
sidstringformat: "uuid"
The unique identifier for this Project.
friendly_namestring
The name of the Project.
statusenum
The status of the Project. Always 'active'.
Allowed values:
auth_tokenstring
The authorization token for this Project. Always returns 'redacted' for security.
date_createdstring
The date and time this Project was created, in RFC 2822 format.
date_updatedstring
The date and time this Project was last updated, in RFC 2822 format.
typeenum
The type of the Project. Always 'Full'.
Allowed values:
owner_account_sidstringformat: "uuid"
The Project ID of the parent project. For parent projects, this is the same as sid.
region_preferencestring
The preferred region for the Project.
uristring
The URI for the Project.
subprojectboolean

Whether this project is a sub-project of another project.

signing_keystring or null
The signing key for the Project. Only returned once when a subproject is created. Subsequent requests return null.
subresource_urisobject

A map of URIs for sub-resources linked to this Project.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error