Update Contact
Each agent API request in TeleCMI platform includes agent login token. After getting the agent 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://piopiy.telecmi.com/v1/updateContact
Required Parameters
These are the required POST method parameters with description
| Parameter Name | Type | Description |
|---|---|---|
| *token | string | Your agent token |
| *name | string | The updated name to save the contact |
| *from | number | The phone number of the saved contact |
| remindme | number | Timestamp for the next remainder |
| string | Update EMail ID for the contact | |
| status | string | Update current status for the contact |
| tag | string | Update tag for the contact |
| info | string | Adding 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",
"from": 9200000000,
"remindme":1636869737000,
"email":"abc@xyz.com",
"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
| Property | Type | Description |
|---|---|---|
| msg | string | Contact updated |
HTTP status codes
TeleCMI API platform represents the following status code to identity the errors.
| Status code | Status Type | Description |
|---|---|---|
| 200 | Success | We received the request |
| 400 | Error | Invalid app id or secret, authentication failed, Missing parameter |