Versions Compared

Key

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

...

  1. When someone Subscribes using the Platform, you can use the Subscription Added Callback.
  2. When someone updates their preferences and personal data outside of the Platform, you can use the Update a Person API.

    Note

    Note: If there is custom data you want to store, you need to set up the custom fields ahead of time.

  3. When someone unsubscribes, you can use the Subscription Removed Callback.


Note

Note: When a Person adds a mobile number to your preference center and you want to sign them up, you should go through the Web-Based Subscriber Management process as described in the previous scenario.


Anchor
Situation One
Situation One
Situation One: New Subscribers - Vibes Mobile Engagement Platform Hosted


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

...

Code Block
titleSubscription Added Callback
{
   "callback:id","DEF123",
   "event_id":"AB234SDFD234",
   "event_type":"subscription_added",
   "event_date":"2017-02-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",
      "acquisition_campaign":{
         "id":"2342312",
         "url":"/companies/:id/campaigns/acquisition/2342312"
      },
      "url":"/companies/:id/mobiledb/persons/ABC123/subscriptions/1234"
   }
}


Note

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


Anchor
Situation Two
Situation Two
Situation Two: 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 from your CRM system (external_person_id), or you can use the Vibes person_id.

Code Block
titleAPI Call: Updating a Person
{
   "external_person_id":"EXT542342",
   "mobile_phone":{
      "mdn":"+12995551234"
   },
   "custom_fields":{
      "first_name":"John",
      "last_name":"Doe"
   }
}


Note

Note: If you are unable to update by ID and only have the Mobile Directory Number (MDN), then you can use the Add Person API call and Vibes will merge the MDN's information with the existing Person.


As shown in the following Return example, you will receive back an HTTP code letting you know if the Person was updated, if the Person was not found, or if the MDN can’t be changed.

...