Types

Contact

Example

{
  "type": "Contact",
  "affiliation": [
    "https://example.com/profile/card#me"
  ],
  "address": [
    {
      "type": "PostalAddress",
      "streetAddress": "1007 Mountain Gate Rd",
      "postOfficeBoxNumber": "Box 1234",
      "addressRegion": "NJ",
      "addressLocality": "Gotham City",
      "postalCode": "10010",
      "addressCountry": "CA",
      "addressCounty": "string",
      "addressSubdivision": "Gotham Heights"
    }
  ],
  "birthDate": "2019-08-24",
  "contactPoint": [
    {
      "type": "ContactPoint",
      "name": "Work",
      "telephone": "555-555-5555",
      "faxNumber": "555-555-5555",
      "email": "bob@example.com",
      "url": "https://www.facebook.com/hallandoates"
    }
  ],
  "email": "user@example.com",
  "additionalName": "Johnny,John",
  "familyName": "Smith",
  "faxNumber": "string",
  "givenName": "John",
  "honorificPrefix": "Dr",
  "honorificSuffix": "Esq",
  "jobTitle": "CEO",
  "knowsLanguage": [
    {
      "type": "Language",
      "name": "English",
      "additionalName": "en-us"
    }
  ],
  "name": "string",
  "telephone": "+15558675309",
  "worksFor": "string",
  "identifier": {
    "bhhsconsumerid": "12345"
  },
  "additionalProperty": {
    "supercrmuserid": 1234,
    "doNotSell": true
  },
  "comment": [
    {
      "type": "Comment",
      "text": "this is my comment.",
      "author": {
        "type": "Contact",
        "name": "Bruce Wayne"
      },
      "about": {
        "type": "PropertyListing",
        "id": "https://example.com/listingid"
      },
      "dateCreated": "2019-07-15T05:24:05Z",
      "dateModified": "2019-07-15T05:24:05Z"
    }
  ],
  "contactGroup": [
    {
      "type": "ContactGroup",
      "identifier": {
        "bhhsconsumerid": "12345"
      },
      "name": "Past Clients"
    }
  ],
  "keywords": [
    "string"
  ],
  "leadOwner": {
    "type": "RealEstateOrganization",
    "name": "Gotham City Real Estate",
    "id": "https://example.com/profile.card#me"
  },
  "leadSource": {
    "id": "https://www.zillow.com/homedetails/1044-Siler-Pl-Berkeley-CA-94705/24820985_zpid/",
    "type": "RealEstateWebsite",
    "name": "Zillow",
    "url": "https://zillow.com"
  },
  "originatingSystem": {
    "type": "SoftwareApplication",
    "name": "RDesk",
    "description": "User Created.",
    "url": "http://www.rdeskwebsite.com/"
  },
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateModified": "2019-08-24T14:15:22Z"
}

Schema

NameTypeDescription
(root)allOf-
0 (allOf item)object-
typestring-
affiliationarray<string>An organization that this person is affiliated with
affiliation (single item)stringformat (uri)
addressarray<object>-
address.typestringconst ("PostalAddress")
address.streetAddressstringthe street address <= 75 characters
address.postOfficeBoxNumberstringThe post office box number for PO box addresses.
address.addressRegionstringabbreviated state or province
address.addressLocalitystringCity, Township. <= 50 characters
address.postalCodestringZip/Post Code <= 12 characters
address.addressCountrystringallowed ("CA", "DE", "GR", "IN", "IT", "MX", "PE", "PT", "ES", "AE", "GB", "US") two-letter ISO 3166-1 alpha-2 country code
address.addressCountystringCounty
address.addressSubdivisionstringthe subdivision or neighborhood (us real estate extension)
birthDatestringdate of birth. format (date)
contactPointarray<object>contact points for the person
contactPoint.typestringconst ("ContactPoint")
contactPoint.namestringa label for the contactPoint, i.e. 'Work', or 'Home'
contactPoint.telephonestring-
contactPoint.faxNumberstring-
contactPoint.emailstringan email address for the item. format (email)
contactPoint.urlstringprimary URL for the item. format (uri)
emailstringa valid email address format (email)
additionalNamestringany other name(s) associated with the entity, i.e. nickname, middle name, maiden name, etc. For multiple names, use a comma without space as a separator.
familyNamestringLast Name of a person. Family Name <= 50 characters
faxNumberstringDo people still use fax machines?
givenNamestringFirst Name of a person
honorificPrefixstringAn honorific prefix preceding a Person's name such as Dr/Mrs/Mr.
honorificSuffixstringAn honorific title following a person's name like M.D.
jobTitlearray<string>job tiles associated with the item
jobTitle (single item)string-
knowsLanguagearray<object>languages spoken by the person
knowsLanguage.typestringconst ("Language")
knowsLanguage.namestringthe display name of the language
knowsLanguage.additionalNamestringBCP 47 language code
namestringFull name of the person.
telephonestringPrimary phone number.
worksForstringOrganizations the person works for.
1 (allOf item)-a CRM contact.
1.typestringconst ("Contact")
1.identifierobject1 properties
1.additionalPropertyobjectadditionalProperty are
1.commentarray<object>comments by, for or about the item
1.comment (single item)object-
1.jobTitlestringThe job title of the person (for example, Financial Manager).
1.contactGrouparray<object>-
1.contactGroup.typestringallowed ("ContactGroup", "Collection")
1.contactGroup.identifierobject1 properties
1.contactGroup.namestring-
1.keywordsarray<string>-
1.keywords (single item)string-
1.leadOwnerobjectlead owner
1.leadSourceobjectorigin of the lead
1.originatingSystemobjectthe original system where this item was created. Can be of type Thing or any sub-type.
1.dateCreatedstringThe date on which the item was created. format (date-time)
1.dateModifiedstringThe date on which the item was most recently modified or when the item's entry was modified within a DataFeed. format (date-time)
Previous
Comment
Next
ContactPoint