API authentication required
Need API Access?

Please use ‘Create Account’ to quickly register and start exploring our APIs

POST

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists

This API allows you to create one or more new lists. A list name has to be unique within an account.

The Lists created using this API can only be used within Call Campaigns.

Parameter
Name
Value
Description
* Body
Jsonbody

name (Mandatory)- Name of list (unique within an account)

tag (optional)- tag value for the list

Response Content Type

POST

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists/<listSid>/contacts

This API allows you to add contacts within an already created list. The contacts should already exists in Campaigns or should be created using Create Contacts API.

This is a bulk API which supports maximum of 5000 contacts in one request.

 

 

Parameter
Name
Value
Description
* listSid
path

ListSid

Parameter
Name
Value
Description
* Body
Jsonbody

Mention contactsids you want to add to the list

“contact references”: [

“contact_sid”: <value>

“contact_sid”:<value>….

]

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

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

 

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

PUT

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists/<listSid>

This API allows you to update the name or tag of a list.

Parameter
Name
Value
Description
* ID
path

listsid

* Body
Jsonbody

you can update name and tag of the list

Response Content Type

PUT

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists

This API allows you update name and tag of multiple lists.

It’s a bulk API and which supports 5000 lists in one request.

Parameter
Name
Value
Description
* Body
Jsonbody

Provide bulk details of sid (mandatory) and the parameters (name and tag) you want to update along with their values.

“lists”: [

{“sid”:<value>},

{“sid”:<value>}……

]

Response Content Type

DELETE

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists/<list_id>

This API allows you to delete an existing list from the Campaign address-book.

Parameter
Name
Value
Description
* ID
path

Replace <id> with the listSid

Response Content Type

GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists/<list_id>

This API allows you to fetch details of an existing list using list_ID.

Parameter
Name
Value
Description
* id
path

listSid

Response Content Type

GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists?limit=<limit>&offset=<offset>

This API allows you get details of lists within an account. This API also allows you to search a particular list by list name and also sort the fetched response by name or date created.

It’s a bulk API which which works with offset & limit parameters to fetch specific set of data.

Parameter
Name
Value
Description
* offset
query

offset (optional)- This is the position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value. Offset is zero-based i.e. the 10th record is at offset 9

* limit
query

limit(optional)- number of records on single page default:20

* name
query

name (optional)-Search on lists name 

* sort_by
query

sort_by (optional)- This indicates in what order the lists records are sorted in the API response. By default records are sorted by DateCreated in ascending order. However, you can override the same in following way for ascending order: Eg: date_created:asc or name:asc

Response Content Type

GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists/<list_id>/contacts?offset=<offset_num>&limit=<limit_num>

This API allows you to fetch all contacts within a list.

It is a Bulk API and supports limit and offset based pagination.

Parameter
Name
Value
Description
* list_id
path

listSid

Parameter
Name
Value
Description
* offset
query

offset (optional)-  By specifying offset, you retrieve a subset of records starting with the offset value. Offset is zero-based i.e. the 10th record is at offset 9

* limit
query

limit(optional)- number of records on single page default:20 maximum=500

Response Content Type

DELETE

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists/<list_sid>/contacts/<contact_sid>

This API allows you to delete an existing list from the Campaign address-book.

Parameter
Name
Value
Description
* list_sid
path

listSid

* contact_sid
path

contactSid

Response Content Type