Skip to main content

Update 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 update the existing contact details.

Base URL

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

https://rest.telecmi.com/v2/user/contact/update

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
*tokenstringYour user token
*namestringThe updated name to save the contact
*phone_numbernumberThe phone number of the saved contact
remindmenumberTimestamp for the next remainder in UTC timezone
emailstringUpdate EMail ID for the contact
statusstringUpdate current status for the contact
tagstringUpdate tag for the contact
infostringAdding notes to the contact
Note
The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
"token": "xxxx-xxxx-xxxx-xxxx",
"name": "Mike",
"phone_number": 9200000000,
"remindme":1636869737000,
"email":"[email protected]",
"status":"hotlead",
"tag":"Not Interested",
"info": "Followup date added"
}

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": "Contact updated"
}

Properties

These are the list of properties and its description

PropertyTypeDescription
msgstringContact updated

HTTP status codes

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

Status codeStatus TypeDescription
200SuccessWe received the request
404ErrorInvalid user token, Failed to authenticate token
400ErrorParameter missing