Update a Group

Update a group, including the group name and the list of P-Series Cloud PBXs in the group.

Request URL

PUT {base_url}/dm/open_api/v1/groups/{id}

Request parameters

Path parameter
Parameter Required Type Description
id Yes Integer The ID of the group.
Note: You can query the group ID using Query All the Groups.
Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.
Body
Parameter Required Type Description
groupName Yes String The name of the group.
Note: The maximum length is 127 characters.
pbxIdList No Array<Integer> The ID(s) of the P-Series Cloud PBXs to be added to the group.
Note:
  • This field performs a full replacement where only the specified IDs remain in the group. If omitted, all existing Cloud PBX instances in the group are removed.
  • You can query the Cloud PBX ID using Query All the Cloud PBXs.
  • Use comma to separate multiple IDs. For example, [389283,96569].

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

Add a Cloud PBX (ID: 25369) to a group (ID: 20039).

PUT /dm/open_api/v1/groups/20039 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******
Content-Type: application/json

{
    "groupName":"API-Created Group 1",   
    "pbxIdList":[276931,300123,25369]  // Retain the ID of existing PBXs (276931&300123)
}

Response example

HTTP/1.1 200 OK
{
    "requestId": "f5285074a23520f2dd765a8411a874e0",
    "status": "Success",
    "time": 1775726933
}