Versions Compared

Key

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

To take full advantage of Catapult's targeting and personalization capabilities, you want to send Catapult relevant data about the subscribers Subscribers in your CRM system. Through a combination of API calls and callbacks, you can keep Catapult in sync with your most current data about peoplePeople

 

API Calls

Mobile Phone Sign-up Scenario (previous scenario)

...

New Subscribers - Customer Hosted

When a person Person adds a mobile number to your preference center, and you want to sign them up, you should go through the Mobile Phone Sign-Up process from the previous scenario.

New Subscribers - Catapult Hosted

When a new subscriber Subscriber comes into your mobile database through a Catapult landing page or SMS opt-in, your CRM system can receive a callback to an API endpoint. The following example shows the standard format for callbacks. 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 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":"2013-08-01T15: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":"2013-01-09T15:34:52Z",
      "opt_out_date":"2013-02-09T15: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

1. At any time, your CRM system can add real-time data about your subscribersSubscribers. 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

For updating, you can use a unique identifier in your CRM system (external_person_id), or you can use the Vibes person_id. If you are unable to update by ID and only have the MDN, then you can use the Add Person API call, and Vibes will merge the MDN's information with the existing person.

...