Buyer Contact Map

BuyerContactMap represents a mapping of buyer contact IDs to contacts

JSON

{
  "property1": {
    "address": {
      "address1": "156 5th Avenue",
      "address2": "string",
      "locality": "New York",
      "postalCode": "10019",
      "region": "US-NY",
      "country": "US",
      "addressType": "Firm"
    },
    "buyerID": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
    "contactType": "PRIMARY",
    "createdAt": "2020-12-31T15:10:55Z",
    "email": "[e-mail]",
    "id": "f322210a-e814-4b1b-a8bf-007a3e765bb9",
    "name": {
      "givenName": "John",
      "familyName": "Doe",
      "additionalName": "string"
    },
    "phone": "[phone]",
    "updatedAt": "2020-12-31T15:10:55Z"
  },
  "property2": {
    "address": {
      "address1": "156 5th Avenue",
      "address2": "string",
      "locality": "New York",
      "postalCode": "10019",
      "region": "US-NY",
      "country": "US",
      "addressType": "Firm"
    },
    "buyerID": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
    "contactType": "PRIMARY",
    "createdAt": "2020-12-31T15:10:55Z",
    "email": "[e-mail]",
    "id": "f322210a-e814-4b1b-a8bf-007a3e765bb9",
    "name": {
      "givenName": "John",
      "familyName": "Doe",
      "additionalName": "string"
    },
    "phone": "[phone]",
    "updatedAt": "2020-12-31T15:10:55Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	object	false	none	BuyerContact represents a set of contact information.
➥ address	object	false	none	Represents a fully defined address for an entity
➥➥ address1	string	true	none	First address line
➥➥ address2	string	false	none	Second address line
➥➥ locality	string	true	none	The locality (e.g. City) of the address.
➥➥ postalCode	string	true	none	The administrative postal code (e.g. Zip Code)
➥➥ region	string	true	none	The region or first-level administration division (e.g. State/Province) of the address.
➥➥ country	string	true	none	The two character ISO-3166-1 country code.
➥➥ addressType	string	false	read-only	Represents the type of address.
➥ buyerID	string(uuid)	false	read-only	ID of the buyer associated with this contact.
➥ contactType	string	false	none	Optional. Represents the type of contact.
➥ createdAt	string(date-time)	false	none	Time this entity was created.
➥ email	string(email)	true	none	Email address.
➥ id	string(uuid)	false	read-only	Unique ID associated with this contact.
➥ name	object	true	none	Full name.
➥➥ givenName	string	true	none	Given name
➥➥ familyName	string	true	none	Family name
➥➥ additionalName	string	false	none	Additional name, if any
➥ phone	string	true	none	Phone number.
➥ updatedAt	string(date-time)	false	none	Time this entity was last updated.

Enumerated Values

Value
Firm
GeneralDelivery
HighRise
POBox
RuralRoute
Street
NoMatch
InternationalNone
InternationalAdministrativeArea
InternationalLocality
InternationalThoroughfare
InternationalPremise
InternationalDeliveryPoint
Other
PRIMARY
HOME
WORK
OTHER
BILLING
SHIPPING