Subscription List API

The Subscription List API stores subscription list entities, which contain information about each subscription list associated with your account. Using this API, you can retrieve a list of all your subscription lists, search for a subscriber on specific lists, see your acquisition campaigns, and more.

Available API Methods

Available Callbacks

Elements & Attributes

Data ElementTypeDescription
idStringIdentifier for this particular subscription
nameStringThe display name for the subscription list
urlStringThe REST API URL to the subscription list entity
subscribers_urlStringThe REST API URL to the subscribers end point.
acquisition_campaigns_urlStringThe REST API URL to the acquisition campaigns list endpoint.

Example Entity

The following shows the JSON representation of a subscription list entity within the APIs.

{
   "id":"ABC12345",
   "name":"Wonderful Subscription List",
   "url":"/companies/:company_key/mobiledb/subscription_lists/ABC12345",
   "subscribers_url":"/companies/:company_key/mobiledb/subscription_lists/ABC12345/subscribers",
   "acquisition_campaigns_url":"/companies/:company_key/mobiledb/subscription_lists/ABC12345/acquisition_campaigns"
}