Back View all Articles

Introducing the Lists API: Notify Lists of Users With One API Call

Posted by Nate Munger on October 13th, 2020

Companies today send user notifications across a growing number of platforms and channels. To help you send the right notification on the right channel at the right time, Courier lets you define your user preferences and store them on a recipient profile via our Profiles API

But there’s another challenge: many times there are groups of users you want to message with the same notification triggered by the same event. 

In the past, this meant tens or sometimes thousands of API calls triggering the same notification over and over. But now, with the release of Courier’s Lists API, you’re able to create lists, subscribe recipient profiles to them, and notify every user on the list with a single Send API call. 

Courier handles the message fanout – following user preferences and your channel priorities – to deliver across email, SMS, mobile push, messaging apps, and more.

Send to a List with cURL

With the Lists API, you can easily do things like: 

  • Reach every user in a shared workspace.  

  • Notify all users who follow a specific project.

  • Message users who opt in to select notifications. 

Wildcard Sends: Notify subscribed users, across multiple lists, with one API call

The Lists API accepts List IDs with up to four parts. Giving you plenty of flexibility to create lists for almost any use case.

  • part1

  • part1.part2

  • part1.part2.spart3

  • part1.part2.part3.part4

Following this basic pattern when defining List IDs will enable wildcard sending. This means you can send to multiple list parts within a related pattern using a single API call.  

Send to a List Pattern with cURL

When sending to a Pattern that matches multiple Lists, Courier will send only one notification to any user with multiple matching subscriptions.

Get started with the Lists API

For more details on how to create and send to lists, check out the Lists API reference doc. You can read more about how to name your lists and use wildcards in our Lists API help article.

Read more:

Courier Live: First Look at Notifying Multiple Recipients using Lists

Nate Munger