Add Contact(Async Mode)
This API allows the user to create a new user in CEE, either individually or in a list in an async manner.
Details
URL Schema:
US IDC:
Indian IDC:
EU IDC:
Method:
POST
Header:
| Key | Value |
|---|---|
| Content-Type | application/x-www-form-urlencoded |
Parameters:
| Parameter | Description | Data Type | Required | Parameter Type |
|---|---|---|---|---|
| activity | Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on. Value here: add | String | Yes | Query Parameter |
| data | Data is the input which comprises the raw parameters like listname, subject, from, and so on. For example: json format data e.g. { "NAME": "Mike", "EMAIL": "[email protected]", "MOBILE":5654134, "AGE":24, "CITY":"Mumbai" } Here EMAIL is the primary key of contact. | String | Yes | Body Parameter |
| listid | Each list in CEE has a unique ID assigned to it to identify. Passing this ID is required to let the API know to which list the contact is to be added. | Integer | Optional | Body Parameter |
| apikey | You can obtain the API key from the CEE panel. Log in to your CEE panel and go to Admin. Enable the API Mode in Account Configuration under Advance details. Now, go to Sub Admin and click Edit on your user name. You can view your API key here. | string | Yes | Query Parameter |
| type | It represents the module or group the API belongs to. For example, if the API 's functionality is related to Contacts, type is 'contact'. value here: contact | string | Yes | Query Parameter |
Request:
Sample Curl URL:
curl --location 'https://api.netcoresmartech.com/apiv2?type=contact&activity=add&listid=2&apikey=<CE API Key>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'data={"USERID": "AJ2020","FIRSTNAME": "Arjun", "EMAIL": "[email protected]", "MOBILE":9910099100, "AGE":34, "CITY":"Delhi" }'
Response: Success 200 OK
{
"requestid": "f1249cd84784d423ee163eca804a4eaa",
"result": "Success"
}
{
"result": "Invalid API key"
}
Updated about 2 months ago