Update the Information of a Cloud PBX

Update the name or feature setting of a specific Cloud PBX.

Request URL

PUT {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}

Request parameters

Path parameter
Parameter Required Type Description
cloudPbxId Yes Long The ID of the Cloud PBX.
Note: You can query the Cloud PBX ID using Query All the Cloud PBXs.
Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.
Body
Parameter Required Type Description
name Yes String PBX name.
upgradeInPbx Yes String Whether to enable firmware upgrading on PBX side.
Valid value:
  • Enabled
  • Disabled
im Yes String Whether to enable internal chat feature (IM) of the Cloud PBX.
Note: The setting can be applied to the P-Series Cloud PBXs with a firmware version of 84.12.0.32 or later.
Valid value:
  • Enabled
  • Disabled
passwordlessLogin Yes String Whether to enable passwordless login to the Cloud PBX.
Valid value:
  • Enabled
  • Disabled
allowSuperiorPasswordlessLogin Yes String Whether to enable passwordless login to the Cloud PBX for your superior account.
Note: The setting of this parameter only takes effect when passwordlessLogin is set to Enabled.
Valid value:
  • Enabled
  • Disabled
provisioningViaTemplate No String Whether to allow the Cloud PBX to be provisioned via a template.

Valid value:

  • Enabled
  • Disabled

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
status String Request result:
  • Success
  • Failed
time Long The response time.
Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.

Example

Request example

Disable the 'Passwordless Login' feature for the Cloud PBX (ID: 42100).
PUT /dm/open_api/v1/cloud_pbx/instances/42100 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ1MTY5MjJ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NTE4NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI1NmZhYTE0Ni0wZjUyLTRhYjEtYjkyNy1jNDZiMjRkNjc1MTYiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.jOfSRWoL0lXUd3_xRsVpvymkqu7FuLyrAGIIoNbsh_U
Content-Type: application/json
{
   "name": "Yeastar P-Series Cloud PBX",
   "upgradeInPbx": "Enabled", 
   "im": "Enabled",
   "passwordlessLogin": "Disabled",
   "allowSuperiorPasswordlessLogin": "Disabled",
   "provisioningViaTemplate": "Enabled"
}
Response example
HTTP/1.1 200 OK
{
  "requestId": "fe23cdd17f7de47f9ec9b78aa72253e6",
  "status": "Success",
  "time": 1664518676
}