Delete Groups

Delete one or multiple groups.

Request URL

DELETE {base_url}/dm/open_api/v1/groups

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.
Body
Parameter Required Type Description
ids Yes Array<Integer> The ID(s) of the groups to be deleted.
Note:
  • You can query the group ID using Query All the Groups.
  • Use comma to separate multiple IDs. For example, [1001,1005].

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

Delete a group (ID: 19997).

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

{
    "ids":[19997]
}

Response example

HTTP/1.1 200 OK
{
    "requestId": "0bcb13a8e0150ae727eb03327ded528a",
    "status": "Success",
    "time": 1775718353
}