Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Easily keep Catapult in sync with your most current People data.
  • Have your system notified each time a Person is confirmed on a list or opts out of a list.
  • Have your system notified when data is exchanged between the two systems.  

Image Modified

New Subscribers - Customer Hosted

When a Person adds a mobile number to your preference center, and you want to sign them up, you should go through the Subscriber Sign-up Through a Mobile Phone process as described in the previous scenario.

New Subscribers - Catapult Hosted

When a new Subscriber comes into your mobile database through a Catapult landing page or Short Message Service (SMS) opt-in, your CRM system can receive a callback to an API endpoint.

...

Note: If you need Catapult to call a pre-existing API, the Vibes Mobile Solutions Group can create a custom integration solution for you.

Opting Out Subscribers

When a Person opts out via their mobile device, Catapult will send your system a notification that they are no longer a mobile Subscriber, as shown in the following example. 

Code Block
titleSubscription Removed Callback
{
   "callback_id":"DEF124",
   "event_id":"AB234SDFD234",
   "event_type":"subscription_removed",
   "event_date":"2017-03-15T15:42:23Z",
   "delivery_attempt":"1",
   "subscription":{
      "person":{
         "id":"ABC123",
         "external_id":"ex1234",
         "url":"/companies/:id/mobiledb/persons/ABC123"
      },
      "subscription_list":{
         "id":"1234",
         "url":"/companies/:id/mobiledb/subscription_lists/1234"
      },
      "opt_in_date":"2017-01-15T15:34:52Z",
      "opt_out_date":"2017-02-18T15:34:52+0000",
      "opt_out_reason":"user_opt_out",
      "acquisition_campaign":{
         "id":"2342312",
         "url":"/companies/:id/campaigns/acquisition/2342312"
      },
      "url":"/companies/:id/mobiledb/persons/ABC123/subscriptions/1234"
   }
} 

How to Add Data About Your Subscribers

Your CRM system can add near real-time data about your Subscribers at any time. Please work with your Vibes Account Manager to determine the best format in which to store your data. Vibes supports strings, multi-select and single-select lists, date/time, as well as other formats. 

...

Code Block
titleReturn: Adding Person
SUCCESS: 200, 201 - person added or person merged/updated
Same Person body you submitted is returned

Updating Data About Your Subscribers

As shown in the following API Call example, when updating data about your Subscribers, you can use a unique identifier in your CRM system (external_person_id), or you can use the Vibes person_id.

...