Delete Customers

Restriction

NOT allowed to delete a customer that is associated with a P-Series Cloud PBX.

Request URL

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

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
customerIds	Yes	Array <Long>	The ID(s) of the customer(s) that you want to delete. Note: You can query the customer ID using Query all the Customers or Query the Customer(s) of a Cloud PBX. 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 customer A (ID: 50429525) and customer B (ID: 50429524).

DELETE /dm/open_api/v1/customers HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQyNzI1OTR9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0Mjc0Mzk0LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJlNmMzYWRkMi1kYzQ0LTQ2ZmEtYjE0ZS0wM2VjNmYwZTI3ZGEiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.HzH9Gz2pVKeAi9fFFvNTlYltvDVjWSUxbCBPHwaHRL
Content-Type: application/json
{
   "customerIds":[50429525,50429524]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "15eba94d-c5b2-47c4-bdcc-109322195bea",
  "status": "Success",
  "time": 1664270677
}