Skip to main content

Delete Contact

Each user API request in TeleCMI platform includes user login token. After getting the user login token, make a POST request to the below base URL to delete one or more contacts based on their UUIDs.

Base URL

Send your POST method request with valid parameters, to the following base URL.

https://rest.telecmi.com/v3/contact/delete

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
*tokenstringYour user token
*contact_idsarrayList of contact UUIDs to delete (max 100)
Note
The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
"token": "xxxx-xxxx-xxxx-xxxx",
"contact_ids": [
"d3b07384-d113-4ec5-a5ae-be81d6e3c239"
]
}

Sample Response

If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below

{
"code": 200,
"msg": "Contacts Deleted Successfully"
}

Properties

These are the list of properties and its description

PropertyTypeDescription
codenumberHTTP status code (200 for success)
msgstringResponse message details

HTTP status codes

TeleCMI API platform represents the following status code to identity the errors.

Status codeStatus TypeDescription
200SuccessContacts Deleted Successfully
400ErrorInvalid request parameters / Validation error
404ErrorAuthenticated user record not found
500ErrorSomething went wrong!