Delete YCM Users

Request URL

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

Request parameters


Parameter	Required	Type	Description
userType	Yes	String	Specify the user type. Valid value: `My Colleague` `Reseller`
userIds	Yes	Array <Long>	The ID(s) of the user(s) that you want to delete. Note: You can query the user ID using Query All the YCM Users. Use a comma to separate multiple IDs.

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 Reseller A (ID:13326) and Reseller B (ID:13328).

DELETE /dm/open_api/v1/users HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0Mzc2MjB9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDM5NDIwLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI4Y2MyNTcwNS0yZjg1LTQ1NzctOWFmYy00NjllZGJmN2Y0ODUiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.6V-WgKLIpGYY-nvmRCqUXmrKvN9ajk8nBBzzw7Jv82s
Content-Type: application/json
{
  userType: "Reseller", 
  userIds: [13326,13328]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "2ffe14a1e92bc4ae222353c60758cc2e",
  "status": "Success",
  "time": 1664434539
}