Add Bulk Contact through File Upload
This API allows the user to add contacts in bulk to the CE panel.
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: bulkupload | String | Yes | Query Parameter |
| path | This refers to the complete path of the hosted .csv file which contains the contact data. File path to private S3 buckets will work once Netcore IPs are whitelisted according to IDC region: US - 44.199.15.1 Indian - 15.206.255.213 EU - 13.49.233.89 | String | Yes | Body Parameter |
| listid | Each list in CE 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 CE panel. Log in to your CE 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 |
| notifyemail | Once the bulk upload request is triggered, the upload process begins in the background. You may want to get notified when the upload is completed. This is the email ID to which the notification email is sent. | string | Optional | |
| callback | This refers to the pingback URL that receives the status of the upload job. Ensure that your callback endpoint supports the POST method. Callback notifications are sent when the bulk upload job is processed, including Contact Master uploads where no list is associated with the upload. | string | Optional |
Request:
Request URL:
https://api.netcoresmartech.com/apiv2?type=contact&activity=bulkupload&apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxx&path=<PATH OF YOUR FILE>&listid=33&[email protected]&callback=<URL>
Response: 200 OK
{
"requestid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"result": "Success"
}
This API is asynchronous. A successful 200 OK response only confirms that the upload request has been accepted for processing and does not indicate job completion.
You can track the final status of the upload through:
- The callback URL specified in the callback parameter.
- The email address specified in the notifyemail parameter.
Contact Master Uploads: Callback notifications are also sent for Contact Master uploads where no listid is provided. In such cases, the callback contains the processing status of the Contact Master upload job even though no list association exists.
Success Status (200)
This API is asynchronous, so a successful status does not guarantee job completion. Track job status using the endpoint in the callback key or the email in notifyemail key.