About
Use this request to perform a partial update on an existing project (Property). Only the fields provided in the request body will be updated.
Resource URI
PATCH
/v2/Properties/[PropertySid]Request
Headers
| Header | Value | Description |
|---|---|---|
| Content-Type | application/merge-patch+json | The required content type for JSON Merge Patch requests. |
URI Parameters
| Parameter | Type | Description |
|---|---|---|
| PropertySid | string | The secure identifier of the project to update. |
Resource Parameters
These parameters can be included in the request body to update the project record.
| Parameter | Type | Description |
|---|---|---|
| Name (Optional) | string | Update the name of the project. |
| MainDomain (Optional) | string | Update the main domain associated with the project. |
| TimeZone (Optional) | string | Update the Windows Time Zone ID for the project (e.g., "AUS Eastern Standard Time"). |
| SmsEnabled (Optional) | boolean | Enable or disable SMS functionality. |
| CallRecordingEnabled (Optional) | boolean | Enable or disable call recording. |
| IntegrationsEnabled (Optional) | boolean | Enable or disable integrations. |
| Active (Optional) | boolean | Activate or deactivate the project. |
Example: Updating the name and enabling SMS functionality.
{
"Name": "Updated Project Name",
"SmsEnabled": true
}Response
204 – No Content
A successful update request will return a 204 No Content status code, indicating that the request has been successfully processed.
400 - Error
For error codes and messages, please refer to the REST API Error Codes page.