Lists
Methods to create and manage lists using Node SDK
The Lists SDK methods lets you create / manage list of subscribers. You can then send broadcast to all the users in the list or create a workflow that triggers when a new user enters / exits list.
Create / Update List
You can use supr_client.subscribers_list.create
method to create a new list
Guidelines on defining the list_id
list_id
is case-insensitive. Suprsend first converts list_id to lowercase before storing it or doing any sort of comparison on it.list_id
can be of max 64 characters.- It can contain characters [a-z0-9_-] i.e. alphanumeric characters, _(underscore) and -(hyphen).
Get list data
You can get the latest information of a list using supr_client.subscribers_list.get
method.
Get list of lists
To get the data of all the lists created in your workspace, use supr_client.subscribers_list.get_all()
method
Add Subscribers to list
Use supr_client.subscribers_list.add()
to add list subscribers. There is no limit to the number of subscribers that you can add to a list.
Remove Subscribers from list
You can remove subscribers from the list using supr_client.subscribers_list.remove()
Delete list
Replace users in the list
In case you want to refresh list with a new set of users completely, you can replace users by creating a draft version of the list and updating users in it.
Start Sync to create draft version of the list
This method will create a draft version of the list where you can add the new set of users to replace users.
Add Subscribers to draft list
You can use this method to add subscribers to List draft version created in Step 1. You’ll get version_id
in start sync response.
Remove Subscribers from draft list
You can use this method to remove subscribers from List draft version created in Step 1. You’ll get version_id
in start sync response.
Finish Sync to make the draft version live
Once your subscribers are updated in the list, use this method to finish sync and make the draft version updated in above steps live.
Delete Draft List
You can also delete draft list if it’s created by mistake.