About

Use this request to create a new project (Property) associated with your account. Projects act as containers for your numbers and configuration.

Resource URI

POST
/v2/Properties

Request

Resource Parameters

Parameter Type Description
Name (Required) string The name of the new project.
MainDomain (Required) string The main domain associated with the project.
TimeZone (Required) string The Windows Time Zone ID for the project (e.g., "AUS Eastern Standard Time").
SmsEnabled (Optional) boolean Whether to enable SMS functionality. Default is false.
CallRecordingEnabled (Optional) boolean Whether to enable call recording. Default is false.
IntegrationsEnabled (Optional) boolean Whether to enable integrations. Default is false.
Active (Optional) boolean Whether the project should be created as active. Default is true.

Example: Creating a new project.

{
  "Name": "New Marketing Project",
  "MainDomain": "marketing.example.com",
  "TimeZone": "AUS Eastern Standard Time",
  "SmsEnabled": true,
  "Active": true
}

Response

200 – OK

The server will respond with JSON formatted data containing the details of the created project.

Response Parameters

Parameter Type Description
Property object The created project object. See the Project Object Parameters for details.

Example: An example response.

{
  "Property": {
    "AccountSid": "AG5T3HFR5ASD54FS5GB3SDAFJAKSH6DS",
    "PropertySid": "S1234567890ABCDEF1234567890ABCDE",
    "Name": "New Marketing Project",
    "MainDomain": "marketing.example.com",
    "TimeZone": "AUS Eastern Standard Time",
    "SmsEnabled": true,
    "CallRecordingEnabled": false,
    "IntegrationsEnabled": false,
    "Active": true
  }
}

400 - Error

For error codes and messages, please refer to the REST API Error Codes page. Common errors for this endpoint include:

  • UNKNOWN_TIME_ZONE: The provided time zone is not a recognized Windows Time Zone ID.
  • PARAMETER_REQUIRED: A required parameter (Name, MainDomain, TimeZone) is missing.