Versions Compared

Key

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

...

A Person can also be tracked/linked by a Mobile Directory Number (MDN). This alternate identifier is sufficient in the short-term, but it is not an ideal long-term identification method because mobile numbers can be changed, returned, ported, and recycled.


Note

Note: A If you are using Version 2 of the APIs, a mobile number must use the E.164 format. E.164 is the official format for all international phone numbers that includes a plus sign followed by the country code and phone number.For example:

  • U.S.: +12135551234
  • U.K.: +442135551234

...

The following is the JSON representation of a Person entity within the APIs.

Note
Note: The following example is of Version 2 of the APIs that uses the E.164 international MDN format (+1). If you are using Version 1 of the API, you cannot use the (+1) E.164 format).


Code Block
{
   "person_id":"c5235a1-e243-42z7-979c-7f6234kl21b60",
   "external_person_id":"542342",
   "mobile_phone":{
      "mdn":"+12995551234",
      "carrier_code":"104"
   },
   "custom_fields":{
      "first_name":"Steve",
      "birthdate":"1950-12-01T00:00:00Z",
      "rewards_id":"543557654",
      "favorite_stores":[
         {
            "id":"4",
            "name":"My Hardware Store"
         },
         {
            "id":"12",
            "name":"Local Grocery"
         }
      ]
   },
   "created_at":"2017-01-05T14:30Z",
   "updated_at":"2017-02-08T19:30Z",
   "url":"/companies/:id/mobiledb/persons/:person_id"
}

...

Data Element

Type

Description

person_id

String

Vibes unique identifier for each Person record in the Mobile Database.

external_person_id

String

Customer unique identifier for a Person in the Mobile Database. This value is optional, but if specified, must be unique within the Mobile Database.

Person identifiers that are canonical in external systems can be assigned to Person resources in the "external_person_id" field. Any string value can be assigned as the external person id. If the external_person_id value contains non-URL-safe characters, they must be encoded if used in the URL.

mobile_phone

Object

Object representation of a Person's mobile phone. A Person can have only one active Mobile Phone at a time.

mobile_phone.mdn

String

The Mobile Directory Number (a number that can be dialed).

If you are using Version 1 of the APIs, do not use the E.164 MDN format (+1).

If you are using Version 2 of the APIs, It must be in E.164 format, for example: +12195551234.

mobile_phone.carrier_code

String

The Cellular Carrier associated with this mobile number.

custom_fields

Object

Additional Field Types like String, Date, Single-Selection, and Multi-Selection.

...