Add Contact(Sync Mode)
This API allows the user to create a new user in CEE, either individually or in a list in a sync manner
Details
URL Schema:
US IDC:
https://api.netcoresmartech.com/apiv2
Indian IDC:
https://apiin.netcoresmartech.com/apiv2
EU IDC:
https://jsonapi.eu-north-1.eu.netcoresmartech.com/apiv2
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: addsync | 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 |
Difference between Sync and Async APIs
The only difference between the two APIs is that the sync API does a validation on the server side(on the basis of API Key, Primary Key etc.) before returning the response, while the async API validate only the API key and returns a success response.
Request:
Request URL:
https://api.netcoresmartech.com/apiv2?type=contact&activity=addsync&apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxx&data=%7B%22FIRST_NAME%22%3A%22Mike%22%2C%22EMAIL%22%3A%22mike%40google.com%22%2C%22MOBILE%22%3A9999999999%2C%22CUSTOMER_ID%22%3A%2200000132%22%7D&listid=33
Response Examples:
Response 1: 200 OK
{
"requestid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"result": "Success"
}
Response 2: 302 ERROR
{
"status": "error",
"error_code": 302,
"details": "Duplicate entry 'xxxxxxxxxxxxxxxxxxxxx' for key 'uniqid'"
}
Updated 4 months ago