Skip to main content

Add 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 add one or more contacts to the organization.

Base URL

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

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

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
*tokenstringYour user token
*contactsarrayList of contact objects (max 100)

Contact Object Fields

FieldTypeRequiredDescription
*phone_nostringYesContact's phone number
*first_namestringYesContact's first name
*last_namestringYesContact's last name
email_idstringNoContact's email address
companystringNoCompany name
job_titlestringNoJob title
Note
The * marked parameter/field is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
"token": "xxxx-xxxx-xxxx-xxxx",
"contacts": [
{
"phone_no": "919200000000",
"first_name": "John",
"last_name": "Doe",
"email_id": "john.doe@example.com",
"company": "Acme Corp",
"job_title": "Software Engineer"
}
]
}

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 added 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
200SuccessContact added successfully
400ErrorInvalid request parameters / Validation error
404ErrorAuthenticated user record not found
409ErrorDuplicate contact detected within the organization
500ErrorSomething went wrong!