contact#add

Message

a contact (data.object) is added by a user (data.agent), optionally to a specific targetCollection

Payload Example(s) (generated)

{
  "topic": "realestate/contact#add",
  "data": {
    "type": "AddAction",
    "agent": {
      "type": "Person",
      "name": "string",
      "email": "user@example.com",
      "identifier": {
        "bhhsconsumerid": "12345"
      }
    },
    "object": {
      "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"
    }
  }
}

Payload

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

Headers

NameTypeDescription
(root)object-
timestringdate & time the event was produced format (date-time)
agentstringif you are a multi-tenant app, then the agent is the user associated with the event data. any future events related to this message will be sent to the same agent/recipient format (uri)
instrumentstringthe app or service that produced the event on behalf of the agent/user format (uri)
sourcestringa copy of the event was sent to the source(s). format (uri)
originalRecipientstringthe originalRecipient helps you determine the subscription that delivered the event to you. if the originalRecipient is the same as the agent, then the you are subscribed to the agent. if the originalRecipient is different from the agent, then you are subscribed to the event source format (uri)
idstringthe Event ID (aka "Publish ID") is the immutable canonical identifier for the event. it is a URI that is unique to the event and will not change. all subscribers will receive the same id for the same event. format (uri)
@idstringformat (uri)

Tools

Next
Getting started