Skip to end of metadata
Go to start of metadata

Last Updated: Monday, January 7, 2019



Get All Subscription Lists

The following will return all the Subscription Lists in the Mobile Database for the specified company.

GET /companies/:company_id/mobiledb/subscription_lists
Note: To get your company ID, please contact your Vibes account manager.

Request JSON

There is no Request JSON with a GET.

Return JSON

The following is an array of Subscription List objects for the specified company.

[
   {
      "id":"ABC12345",
      "name":"Wonderful Subscription List",
      "url":"/companies/:company_id/mobiledb/subscription_lists/ABC12345",
      "subscribers_url":"/companies/:company_id/mobiledb/subscription_lists/ABC12345/subscribers",
      "acquisition_campaigns_url":"/companies/:company_id/mobiledb/subscription_lists/ABC12345/acquisition_campaigns"
   },
   {
      "id":"ABC123",
      "name":"Discount Offers List",
      "url":"/companies/:company_id/mobiledb/subscription_lists/ABC123",
      "subscribers_url":"/companies/:company_id/mobiledb/subscription_lists/ABC123/subscribers",
      "acquisition_campaigns_url":"/companies/:company_id/mobiledb/subscription_lists/ABC123/acquisition_campaigns"
   }
]

Get Subscription List

The following will return the Subscription List object for the specified ID.

GET /companies/:company_id/mobiledb/subscription_lists/:subscription_list_id

Request JSON

There is no Request JSON with a GET.

Return JSON

The Subscription List object.

{
  "id": "12345",
  "name": "ExampleSubscriptionListObject",
  "url": "/companies/:company_id/mobiledb/subscription_lists/12345",
  "subscribers_url": "/companies/IuwDev2W/mobiledb/subscription_lists/1/subscribers",
  "acquisition_campaigns_url": "/companies/:company_id/mobiledb/subscription_lists/12345/acquisition_campaigns"
}
Note: A 404 - Not Found error will be returned if the Subscription List could not be located.

Get Acquisition Campaigns

The following will return an array of active Acquisition Campaign references that point to the specified Subscription List.

GET /companies/:company_id/mobiledb/subscription_lists/:subscription_list_id/acquisition_campaigns

Request JSON

There is no Request JSON with a GET.

Return JSON

{
    "acquisition_id": "R2Av0HaY",
    "description": "Example",
    "campaign_type": {
      "code": "ACQUISITION"
    },
    "status": "past",
    "start_date": "2015-10-24T15:15:05Z",
    "end_date": "2016-10-02T15:14:57Z",
    "created_date": "2015-10-24T15:15:05Z",
    "updated_date": "2016-10-02T15:14:58Z",
    "acquisition_campaign": {
      "keywords": [
        "EXAMPLETEAM"
      ]
    },
    "sourcecode": "12345",
    "url": "/companies/:company_id/campaigns/acquisition/R2Av0HaY"
  },
Note: A 404 - Not Found error will be returned if the Subscription List could not be located.

Search for Subscriber

GET /companies/:company_id/mobiledb/subscription_lists/:subscription_list_id/subscribers?person_id=:person_id \\
GET /companies/:company_id/mobiledb/subscription_lists/:subscription_list_id/subscribers?external_person_id=:external_person_id \\
GET /companies/:company_id/mobiledb/subscription_lists/:subscription_list_id/subscribers?mdn=:mdn

This will search for a Subscriber on the specified Subscription List by person_id, external_person_id or MDN.

Request JSON

There is no Request JSON with a GET.

Return JSON

The following returns the Person object that was located.

{
   "person_id":"AB3423",
   "external_person_id":"542342",
   "mobile_phone":{
      "mdn":"+12995551234",
      "carrier_code":"104"
   },
   "custom_fields":{
      "first_name":"Steve",
      "rewards_id":"543557654",
      "favorite_stores":[
         {
            "id":"4",
            "name":"My Hardware Store"
         },
         {
            "id":"12",
            "name":"Local Grocery"
         }
      ]
   },
   "created_at":"2017-01-15T14:30Z",
   "updated_at":"2017-02-18T19:30Z",
   "url":"/companies/:company_id/mobiledb/persons/:person_id"
}
Note: A 404 - Not Found error will be returned if the Subscription List could not be located or if the specified Person is not subscribed to the list.
  • No labels