Code preference:
Curl
Ruby
Php
Python
Node.js
C#
Java

List

Developers can access their list information as well as manage their list using this API. Following are the various operations supported by this API.

This API call will let you access all the list information under the account.

Input Parameter Description
list_parent This is the existing folder id & can be used to get all lists belonging to it [Optional].
page Maximum number of records per request is 50, if there are more than 50 lists then you can use this parameter to get next 50 results [Mandatory].
page_limit This should be a valid number between 1-50 [Mandatory].

Example :

Sample Output :

Note: The field total_blacklisted in the output data, i.e. the count of blacklisted contacts has been deprecated.

This API call will let you access the specific folder information.

Input Parameter Description
id Id of list to get details [Mandatory].

Example :

Sample Output :

Note: The field total_blacklisted in the output data, i.e. the count of blacklisted contacts has been deprecated.

This API call will let you create a new list.

Input Parameter Description
list_name Desired name of the list to be created [Mandatory].
list_parent Folder ID [Mandatory].

Example :

Sample Output :

This API call will let you update name of the list, or can change its parent (folder) or can do both.

Input Parameter Description
id Id of list to be modified [Mandatory].
list_name Desired name of the list to be modified [Optional].
list_parent Folder ID [Mandatory].

Example :

Sample Output :

This API call will let you delete the specific list information.

Input Parameter Description
id Id of list to be deleted [Mandatory].

Example :

Sample Output :

This API call will let you add already existing users in the SendinBlue contacts to the list.
Please note that these are not designed to be a bulk call.

Input Parameter Description
id Id of list to link users in it [Mandatory].
users Email address of the already existing user(s) in the SendinBlue contacts. Example: “test@example.net”. You can use commas to separate multiple users [Mandatory].

Example :

Sample Output :

This API call will let you delete ( unlink ) already existing users in the SendinBlue contacts from the list.
Please note that these are not designed to be a bulk call.

IMPORTANT NOTE: To delete ( unlink ) all existing users from the list, just do not pass users input parameter.

Input Parameter Description
id Id of list to unlink users from it [Mandatory].
users Email address of the already existing user(s) in the SendinBlue contacts to be modified. Example: “test@example.net”. You can use commas to separate multiple users [Optional].

Example :

Sample Output ( to unlink mentioned users ) :

Note: “failed” : [ “example1@example.net” ] you will find email id’s which were not attached to the given list id.

Sample Output ( to unlink all users, i.e. empty whole list at once, let’s say having 2000 users ) :

This API call will let you display details of all users for the given lists.

Input Parameter Description
listids These are the list ids to get their data. The ids found will display records [Mandatory].
timestamp This is date-time filter to fetch modified user records >= this time. Valid format Y-m-d H:i:s. Example: “2015-05-22 14:30:00″ [Optional].
page Maximum number of records per request is 500, if in your list there are more than 500 users then you can use this parameter to get next 500 results [Optional].
page_limit This should be a valid number between 1-500 [Optional].

Example :

Sample Output :