×
POST

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/contacts/csv-upload

This API allows you to add new contacts in a list using a CSV. The CSV must be present in local to the client triggering the API. The API uploads the contacts in asynchronous manner. The status of upload, at any point of time, can be fetched by hitting the URL (present in summary section of the API response). 

Maximum of 1 Lakh contacts can be added in a list using this API. If the list already exists and has contacts, then it can allow addition of new contacts only up till maximum of 1 Lakh. 

CSV should contain ‘number’ (in E.164 format) as a mandatory column, while other optional columns are: first_name, last_name, company_name, email & tag. Custom field is not allowed to be added against contacts, in this method. The contact parameters can be referred from the API ‘Create Contacts‘.

Parameter
Name
Value
Description
* Body
Jsonbody

list_name (Mandatory)- The list name in which the new contacts will be added

file_name (Mandatory)- The local path of the file which will be used to upload the contacts.

type (Optional)- static/dynamic. Default is static.

 

GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/csv-status/<upload_id>

CSV upload Status

The status of CSV upload can be checked in real-time using the ‘summary:url’ in the above response as a GET API. The response of this request will show the overall status and stats of contacts being uploaded.

Parameter
Name
Value
Description
* ID
path

upload_id

Response Content Type
POST

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/contacts/csv-upload

This API allows you to add new contacts in a list using a CSV. The CSV must be present in local to the client triggering the API. The API uploads the contacts in asynchronous manner. The status of upload, at any point of time, can be fetched by hitting the URL (present in summary section of the API response). 

Maximum of 1 Lakh contacts can be added in a list using this API. If the list already exists and has contacts, then it can allow addition of new contacts only up till maximum of 1 Lakh. 

CSV should contain ‘number’ (in E.164 format) as a mandatory column, while other optional columns are: first_name, last_name, company_name, email & tag. Custom field is not allowed to be added against contacts, in this method. The contact parameters can be referred from the API ‘Create Contacts‘.

Parameter
Name
Value
Description
* Body
Jsonbody

list_name (Mandatory)- The list name in which the new contacts will be added

file_name (Mandatory)- The local path of the file which will be used to upload the contacts.

type (Optional)- static/dynamic. Default is static.

 

GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/csv-status/<upload_id>

CSV upload Status

The status of CSV upload can be checked in real-time using the ‘summary:url’ in the above response as a GET API. The response of this request will show the overall status and stats of contacts being uploaded.

Parameter
Name
Value
Description
* ID
path

upload_id

Response Content Type
3
Share