API Reference

The location object

AttributeTypeDescription
namestringName of the location.
addressstringAddress of the physical location.
uidstringPodium unique identifier for location.
createdAtstringWhen the location was created.
phoneNumberstringPhone number of the location.
updatedAtstringWhen the location was updated.
archivedbooleanIf the location has been archived.
addressDetails.unitstringUnit of the location's address.
addressDetails.statestringState of the location's address.
addressDetails.citystringCity of the location's address.
addressDetails.countrystringCountry of the location's address.
addressDetails.roadstringRoad of the location's address.
addressDetails.countryLongNamestringLong country name of the location's address.
addressDetails.houseNumberstringHouse number of the location's address.
addressDetails.postalCodestringPostal code of the location's address.
addressDetails.stateLongNamestringLong state name of the location's address.
displayNamestringName of the location that is displayed in the user interface.
organizationUidstringPodium unique identifier for organization.
archivedAtstringWhen the location was archived.
podiumPhoneNumberstringPodium phone number of the location.
This is the number that customer's will see on their phone's when receiving a message from this location.
{
  "name": "",
  "address": "1650 Digital Dr, Lehi, UT 84043",
  "uid": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2015-01-23T23:50:07Z",
  "phoneNumber": "+18017580580",
  "updatedAt": "2015-01-23T23:50:07Z",
  "archived": false,
  "addressDetails": {
    "unit": "",
    "state": "",
    "city": "",
    "country": "",
    "road": "",
    "countryLongName": "",
    "houseNumber": "",
    "postalCode": "",
    "stateLongName": ""
  },
  "displayName": "Podium, Inc.",
  "organizationUid": "00000000-0000-0000-0000-000000000000",
  "archivedAt": "2015-01-23T23:50:07Z",
  "podiumPhoneNumber": "+18017580580"
}