This API enables the simultaneous uploading of lead information for multiple customers, streamlining the process of managing bulk customer data.
https:///<IP_Domain_Name>:<port>/v1/cc-list/1/process-list/13/leads/17/contact-upload-tasks
Endpoint Breakdown:
/cc-list/1: Targets contact center list with ID 1.
/process-list/13: Targets the process list with ID 13.
/leads/17: Targets the leads list with ID 17.
/contact-upload-tasks: The action to perform the contact upload.
The headers provide metadata for the request, including authentication and content type.
| Header | Value | Description |
|---|---|---|
accept |
*/* |
The client accepts any type of response format. |
authorization |
Basic <base64_encoded_token> |
The authentication credentials. The token is a Base64 encoding of username:password. |
content-type |
multipart/form-data; boundary=... |
Indicates that the request body contains multiple parts (like a file and text fields), separated by the specified boundary string. |
origin |
https://<IP_Domain_Name> |
The origin domain making the request, typically used for CORS (Cross-Origin Resource Sharing) validation. |
These are the data fields sent in the request body as multipart/form-data.
| Parameter | Type | Value (Example) | Description |
|---|---|---|---|
file |
File | contacts.csv |
Required. The CSV file containing the list of leads to be uploaded. |
user_id |
String | john |
Required. The userID of the supervisor or user who is initiating the upload task. |
update_duplicate |
Boolean | false |
If set to true, existing contacts with the same unique identifier will be updated. If false, duplicates will be ignored. |
churn_updated_records |
Boolean | false |
If set to true, any records that are updated will be marked as "churned" or reset for dialing. |
migrate |
Boolean | false |
If set to true, this will trigger a migration process for the exisitng contacts to the specified leadlist mentioned in the endpoint |
header_mapping |
JSON | {"twitter":"", "timezone":"", "facebook":"", "phone2":"", "name":"customer_name", "phone3":"", "phone4":"", "phone5":"", "email":"", "phone1":"phone1"} |
Required. A JSON object that maps the column headers in your CSV file (value) to the corresponding fields in the Ameyo system (key). |
{
“twitter”: “”,
“timezone”: “”,
“facebook”: “”,
“phone2”: “”,
“name”: “customer_name”,
“phone3”: “”,
“phone4”: “”,
“phone5”: “”,
“email”: “”,
“phone1”: “phone1”
}
This tells the system:
name field in Ameyo should be populated from the customer_name column in the CSV.phone1 field in Ameyo should be populated from the phone1 column in the CSV.twitter, email, etc., are not being mapped from this CSV file.{
“metadata”: null,
“method”: “POST”,
“response”: [
{
“data”: {
“task_id”: 4231888909951751
},
“http_code”: 200,
“error_data”: null
}
],
“http_code”: 200,
“request_id”: null
}