Distribution lists

Searching for distribution lists

A distribution list is usually retrieved by its ID, but you can also search for or refer to the distribution list by its name. This feature is based on the unique name requirement for the distribution list.

Apart from the name, the description field can also be used to search for a distribution list. While the name can be directly used to send in messages, the description is solely for the purpose of searching. Once a search yields the required result, the MRI has to be picked from the selected distribution list and then used to send the messages.

Both these operations can be performed by passing the relevant search parameters in the URL as query params:

  • &name= To search for name.
  • &description= To search by description.
  • JSON
  • XML

Search for a distribution list by name

Users can easily append the &name=My DL Name query parameter to search the Whispir API for a specific distribution list.

HTTP 1.1 GET /distributionlists?apikey=<your_api_key>&name=My%20Distribution%20List
Authorization: Basic asdf98nf89asdvasd2r398h8sdf
x-api-key: your_api_key

 

Search for a distribution list by description

Users can easily append the &description=My DL Description query parameter to search the Whispir API for a specific distribution list.

HTTP 1.1 GET /distributionlists?apikey=<your_api_key>&description=company_name
Authorization: Basic asdf98nf89asdvasd2r398h8sdf
x-api-key: your_api_key