Distribution lists

Whispir’s API allows you to categorise your contacts into different groups – distribution lists – to simplify message distribution. There are many benefits to using DLs, including:

  • Effective management and maintenance of contacts.
  • Group messaging.
  • Reporting.

These logical groups can help you to target specific communications to specific people. A contact can be part of any number of groups.

Whispir supports 3 types of distribution lists:

  • Static: In a static distribution list you manually add contacts and, if required, one or more existing distribution lists. The contacts on the list don’t change unless you manually add or remove them (unlike a dynamic distribution list).
  • Dynamic: In a dynamic distribution list you add contacts based on rules relating to information saved in their Whispir profiles. The list of contacts updates automatically if those specified details change in any profiles. For example, if you add contacts based on a specific role (such as ‘trainer’) and a contact moves to a different role, the list will exclude that contact when the message is sent.
  • Shared: You can create a shared distribution list that’s made up of manually selected recipients, like a static distribution list. This list is then available for sharing with other workspaces (unlike static lists).

Only static and dynamic distribution lists can be created via the API. Creating a shared distribution list is restricted to the Whispir platform UI.

  • JSON
  • XML

API endpoint

Generic

https://api.<region>.whispir.com/distributionlists/?apikey=<your_api_key>
Content-Type: application/vnd.whispir.distributionlist-v1+json

  

Limited to a workspace

https://api.<region>.whispir.com/workspaces/{:id}/distributionlists/?apikey=<your_api_key>
Content-Type: application/vnd.whispir.distributionlist-v1+json

 

Resource type

application/vnd.whispir.distributionlist-v1+xml
application/vnd.whispir.distributionlist-v1+json

 

Methods supported

GET
POST
PUT
DELETE