API stands for Application Program Interface, and is a set of routines, protocols, and tools for building software applications.The call structure of the APIs is as follows:

In this Section

There are currently two versions of the APIs available. You can see what version you are using by looking at the API header.

X-API-Version: 1

Version 1

This is the default version. It does not accept the international format, E.164 phone numbers.

Note: If you are using Version 1, you cannot use the E.164 format. If you do use it, you will get an error returned.

Version 2

To fully serve its international customers, Vibes released Version 2 of the Vibes Mobile Engagement Platform APIs in 2016 to include support for international E.164 phone numbers.

Example API Version 1

POST
http://public-api.vibescm.com/companies/ABC123/campaigns/acquisition/abc123/participants/
Headers
Content-Type:
Application/JSON
Authorization:
Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
BODY
{
   "external_person_id":"EXT542342",
   "mobile_phone":{
      "mdn":"2995551234"
   },
   "custom_fields":{
      "first_name":"John",
      "last_name":"Doe"
   }
}

Example API Version 2 (E.164 MDN Format)

POST
http://public-api.vibescm.com/companies/ABC123/campaigns/acquisition/abc123/participants/
Headers
Content-Type:
Application/JSON
Authorization:
Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
BODY
{
   "external_person_id":"EXT542342",
   "mobile_phone":{
      "mdn":"+12995551234"
   },
   "custom_fields":{
      "first_name":"John",
      "last_name":"Doe"
   }
}

REST API Tree URI Structure