Person APIs

A Person entity is an identified entity that has interacted with or been loaded into the Mobile Database. It is identified by a person_id, which uniquely identifies the record, or an external_person_id, which is a unique identifier from the customer system for reference and cross-linking.

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.

Associating Person Records

Because of the dynamic nature of mobile participation and campaigns, it is possible that Person records could exist in either the Mobile Database or the Customer system in any sequence/order. The following logic ensures that if the records exist in more than one place, the same Person entity gets tied together to avoid inadvertently linking two different people:

1. The person_id and external_person_id columns are always treated as the same Person record and must be unique (the external_person_id can be omitted if it is not used/exist).
2. If the MDN and carrier_code match an existing Person record, they will be considered the same Person entity. If the carrier_code does not match, then they will be assumed to be different people.
   

Note: Since phone numbers often get ported and/or recycled, and to ensure Mobile Marketing Association (MMA) compliance, it is not a valid assumption that carrier changes are made to the same person.

Person Entity

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

{
   "person_id":"c5235a1-e243-42z7-979c-7f6234kl21b60",
   "external_person_id":"542342",
   "mobile_phone":{
      "mdn":"2995551234",
      "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"
}

Elements

Custom Field Types