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: 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: 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.

...

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
titleReturn: Updating a Person
SUCCESS: 200
Same Person body you submitted is returned
 
 
FAILURE: 404 - person not found
no body
 
FAILURE: 409 - MDN cannot be changed
no body

Anchor
addpersonshort
addpersonshort
Add a Person

Use the following to create a new Person record.

 

POST /companies/:company_id/mobiledb/persons/

 

The person_id, timezone_sourcecreated_at and updated_at fields are not allowed, and any values will be ignored.

The mobile_phone field is optional and can be omitted. All custom fields are also optional and may be omitted.

Anchor
Situation Three
Situation Three
Situation Three: When a Subscriber Opts Out

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

...