Moxi Works Platform Contact entities represent an agent’s contacts in the Moxi Works Platform. More...

Properties
string	AgentUuid `[get, set]`
	This is the Moxi Works Platform ID of the Agent which an Contact entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Contact Update request to be accepted. More...

string	MoxiWorksAgentId `[get, set]`
	This is the Moxi Works Platform ID of the Agent which this Contact entry is to be associated with. This will be a string that may take the form of an email address, or a unique identification string. This data is required and must reference a valid Moxi Works Agent ID for your Contact Update request to be accepted. More...

string	PartnerContactId `[get, set]`
	This is the unique identifer you use in your system that has been associated with the Contact that you are creating. More...

string	ContactName `[get, set]`
	This is the full name of the contact you are creating a Contact record for. You should format this information as first middle last. More...

string	Gender `[get, set]`
	The gender of the contact. This can be male, female, m or f. No matter what is provided in the request, the response payload will return m or f. More...

string	PrimaryEmailAddress `[get, set]`
	This is the email address that should be used first. If provided, the address must conform to RFC 3696. More...

string	SecondaryEmailAddress `[get, set]`
	This is the email address that should be used as an alternate. If provided, the address must conform to RFC 3696. More...

string	PrimaryPhoneNumber `[get, set]`
	This is the phone number that should be used first. More...

string	SecondaryPhoneNumber `[get, set]`
	This is the phone numberthat should be used as an alternate. More...

string	HomeStreetAddress `[get, set]`
	The contact’s home address street, including number and any suite / apartment number information. More...

string	HomeCity `[get, set]`
	The city of the contact’s home address. More...

string	HomeState `[get, set]`
	The state of the contact’s home address. More...

string	HomeZip `[get, set]`
	The zip code of the contact’s home address. More...

string	HomeCountry `[get, set]`
	The country of the contact’s home address. More...

bool	IsNotLead `[get, set]`

string	JobTitle `[get, set]`
	The contact’s professional job title. More...

string	Occuparion `[get, set]`
	The contact’s profession. More...

string	PropertyUrl `[get, set]`
	This should be a valid URL for a property of interest in your system that can be viewed by the agent. More...

string	PropertyMlsId `[get, set]`
	Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the MLS ID of the property of interest. More...

string	PropertyStreetAddress `[get, set]`
	Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the street address of the property of interest, including number and suite/apartment number information. More...

string	PropertyCity `[get, set]`
	Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the city in which the property of interest exists. More...

string	PropertyState `[get, set]`
	Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the state or province in which the property of interest exists. More...

string	PropertyZip `[get, set]`
	Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the postal code in which the property of interest exists. More...

int	PropertyBeds `[get, set]`
	Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the number of bedrooms in the property of interest. More...

int	PropertyBaths `[get, set]`
	Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the number of bathrooms in the property of interest. More...

string	PropertyListPrice `[get, set]`
	Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the list price of the property of interest. More...

string	PropertyListingStatus `[get, set]`
	Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the listing status of the property of interest. This can be any arbitrary string, but for best results, this should be a state like Active, Pending, Sold, Cancelled or any other human readable state that would be useful when presented to the agent. More...

string	PropertyPhotoUrl `[get, set]`
	Use this if you have data about a property that this contact has shown interest in (property of interest); this should be a valid URL to an image of the property of interest. More...

string	SearchCity `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the city / locale used in the listing search criteria. More...

string	SearchState `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the state / region used in the listing search criteria. More...

string	SearchZip `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the zip / postal code used in the listing search criteria. More...

int	SearchMinBaths `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the minimum bathrooms used in the listing search criteria. More...

int	SearchMinBeds `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the minimum bedrooms used in the listing search criteria. More...

int	SearchMinPrice `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the minimum price used in the listing search criteria. More...

int	SearchMaxPrice `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the maximum price used in the listing search criteria. More...

int	SearchMinSqFt `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the minimum square feet of the total living area used in the listing search criteria. More...

int	SearchMaxSqFt `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the maximum square feet of the total living area used in the listing search criteria. More...

int	SearchMinLotSize `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the minimum lot size used in the listing search criteria. More...

int	SearchMaxLotSize `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the maximum lot size used in the listing search criteria. More...

string	SearchMinYearBuilt `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the minimum allowable year built used in the listing search criteria. More...

string	SearchMaxYearBuilt `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the minimum allowable year built used in the listing search criteria. More...

string	SearchPropertyTypes `[get, set]`
	Use this if you have data about listing searches that this contact has performed; this should be the property types used in the listing search criteria. This can be any arbitrary human readable string, but using recognized property types such as Condo, Single-Family, Townhouse, Land, Multifamily will provide more value to the agent. More...

string	Note `[get, set]`
	This is an arbitrary string giving the agent more details about the contact which would not otherwise fit into the Contact record. Any HTML formatting included will be stripped from the note attribute’s data. More...

Detailed Description

Moxi Works Platform Contact entities represent an agent’s contacts in the Moxi Works Platform.

Property Documentation

◆ AgentUuid

string MoxiWorks.Platform.Contact.AgentUuid

getset

This is the Moxi Works Platform ID of the Agent which an Contact entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Contact Update request to be accepted.

◆ ContactName

string MoxiWorks.Platform.Contact.ContactName

getset

This is the full name of the contact you are creating a Contact record for. You should format this information as first middle last.

◆ Gender

string MoxiWorks.Platform.Contact.Gender

getset

The gender of the contact. This can be male, female, m or f. No matter what is provided in the request, the response payload will return m or f.

◆ HomeCity

string MoxiWorks.Platform.Contact.HomeCity

getset

The city of the contact’s home address.

◆ HomeCountry

string MoxiWorks.Platform.Contact.HomeCountry

getset

The country of the contact’s home address.

◆ HomeState

string MoxiWorks.Platform.Contact.HomeState

getset

The state of the contact’s home address.

◆ HomeStreetAddress

string MoxiWorks.Platform.Contact.HomeStreetAddress

getset

The contact’s home address street, including number and any suite / apartment number information.

◆ HomeZip

string MoxiWorks.Platform.Contact.HomeZip

getset

The zip code of the contact’s home address.

◆ JobTitle

string MoxiWorks.Platform.Contact.JobTitle

getset

The contact’s professional job title.

◆ MoxiWorksAgentId

string MoxiWorks.Platform.Contact.MoxiWorksAgentId

getset

This is the Moxi Works Platform ID of the Agent which this Contact entry is to be associated with. This will be a string that may take the form of an email address, or a unique identification string. This data is required and must reference a valid Moxi Works Agent ID for your Contact Update request to be accepted.

◆ Note

string MoxiWorks.Platform.Contact.Note

getset

This is an arbitrary string giving the agent more details about the contact which would not otherwise fit into the Contact record. Any HTML formatting included will be stripped from the note attribute’s data.

◆ Occuparion

string MoxiWorks.Platform.Contact.Occuparion

getset

The contact’s profession.

◆ PartnerContactId

string MoxiWorks.Platform.Contact.PartnerContactId

getset

This is the unique identifer you use in your system that has been associated with the Contact that you are creating.

◆ PrimaryEmailAddress

string MoxiWorks.Platform.Contact.PrimaryEmailAddress

getset

This is the email address that should be used first. If provided, the address must conform to RFC 3696.

◆ PrimaryPhoneNumber

string MoxiWorks.Platform.Contact.PrimaryPhoneNumber

getset

This is the phone number that should be used first.

◆ PropertyBaths

int MoxiWorks.Platform.Contact.PropertyBaths

getset

Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the number of bathrooms in the property of interest.

◆ PropertyBeds

int MoxiWorks.Platform.Contact.PropertyBeds

getset

Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the number of bedrooms in the property of interest.

◆ PropertyCity

string MoxiWorks.Platform.Contact.PropertyCity

getset

Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the city in which the property of interest exists.

◆ PropertyListingStatus

string MoxiWorks.Platform.Contact.PropertyListingStatus

getset

Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the listing status of the property of interest. This can be any arbitrary string, but for best results, this should be a state like Active, Pending, Sold, Cancelled or any other human readable state that would be useful when presented to the agent.

◆ PropertyListPrice

string MoxiWorks.Platform.Contact.PropertyListPrice

getset

Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the list price of the property of interest.

◆ PropertyMlsId

string MoxiWorks.Platform.Contact.PropertyMlsId

getset

Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the MLS ID of the property of interest.

◆ PropertyPhotoUrl

string MoxiWorks.Platform.Contact.PropertyPhotoUrl

getset

Use this if you have data about a property that this contact has shown interest in (property of interest); this should be a valid URL to an image of the property of interest.

◆ PropertyState

string MoxiWorks.Platform.Contact.PropertyState

getset

Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the state or province in which the property of interest exists.

◆ PropertyStreetAddress

string MoxiWorks.Platform.Contact.PropertyStreetAddress

getset

Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the street address of the property of interest, including number and suite/apartment number information.

◆ PropertyUrl

string MoxiWorks.Platform.Contact.PropertyUrl

getset

This should be a valid URL for a property of interest in your system that can be viewed by the agent.

◆ PropertyZip

string MoxiWorks.Platform.Contact.PropertyZip

getset

Use this if you have data about a property that this contact has shown interest in (property of interest); this should be the postal code in which the property of interest exists.

◆ SearchCity

string MoxiWorks.Platform.Contact.SearchCity

getset

Use this if you have data about listing searches that this contact has performed; this should be the city / locale used in the listing search criteria.

◆ SearchMaxLotSize

int MoxiWorks.Platform.Contact.SearchMaxLotSize

getset

Use this if you have data about listing searches that this contact has performed; this should be the maximum lot size used in the listing search criteria.

◆ SearchMaxPrice

int MoxiWorks.Platform.Contact.SearchMaxPrice

getset

Use this if you have data about listing searches that this contact has performed; this should be the maximum price used in the listing search criteria.

◆ SearchMaxSqFt

int MoxiWorks.Platform.Contact.SearchMaxSqFt

getset

Use this if you have data about listing searches that this contact has performed; this should be the maximum square feet of the total living area used in the listing search criteria.

◆ SearchMaxYearBuilt

string MoxiWorks.Platform.Contact.SearchMaxYearBuilt

getset

Use this if you have data about listing searches that this contact has performed; this should be the minimum allowable year built used in the listing search criteria.

◆ SearchMinBaths

int MoxiWorks.Platform.Contact.SearchMinBaths

getset

Use this if you have data about listing searches that this contact has performed; this should be the minimum bathrooms used in the listing search criteria.

◆ SearchMinBeds

int MoxiWorks.Platform.Contact.SearchMinBeds

getset

Use this if you have data about listing searches that this contact has performed; this should be the minimum bedrooms used in the listing search criteria.

◆ SearchMinLotSize

int MoxiWorks.Platform.Contact.SearchMinLotSize

getset

Use this if you have data about listing searches that this contact has performed; this should be the minimum lot size used in the listing search criteria.

◆ SearchMinPrice

int MoxiWorks.Platform.Contact.SearchMinPrice

getset

Use this if you have data about listing searches that this contact has performed; this should be the minimum price used in the listing search criteria.

◆ SearchMinSqFt

int MoxiWorks.Platform.Contact.SearchMinSqFt

getset

Use this if you have data about listing searches that this contact has performed; this should be the minimum square feet of the total living area used in the listing search criteria.

◆ SearchMinYearBuilt

string MoxiWorks.Platform.Contact.SearchMinYearBuilt

getset

Use this if you have data about listing searches that this contact has performed; this should be the minimum allowable year built used in the listing search criteria.

◆ SearchPropertyTypes

string MoxiWorks.Platform.Contact.SearchPropertyTypes

getset

Use this if you have data about listing searches that this contact has performed; this should be the property types used in the listing search criteria. This can be any arbitrary human readable string, but using recognized property types such as Condo, Single-Family, Townhouse, Land, Multifamily will provide more value to the agent.

◆ SearchState

string MoxiWorks.Platform.Contact.SearchState

getset

Use this if you have data about listing searches that this contact has performed; this should be the state / region used in the listing search criteria.

◆ SearchZip

string MoxiWorks.Platform.Contact.SearchZip

getset

Use this if you have data about listing searches that this contact has performed; this should be the zip / postal code used in the listing search criteria.

◆ SecondaryEmailAddress

string MoxiWorks.Platform.Contact.SecondaryEmailAddress

getset

This is the email address that should be used as an alternate. If provided, the address must conform to RFC 3696.

◆ SecondaryPhoneNumber

string MoxiWorks.Platform.Contact.SecondaryPhoneNumber

getset

This is the phone numberthat should be used as an alternate.

The documentation for this class was generated from the following file:

Contact.cs

Properties

Detailed Description

Property Documentation

◆ AgentUuid

◆ ContactName

◆ Gender

◆ HomeCity

◆ HomeCountry

◆ HomeState

◆ HomeStreetAddress

◆ HomeZip

◆ JobTitle

◆ MoxiWorksAgentId

◆ Note

◆ Occuparion

◆ PartnerContactId

◆ PrimaryEmailAddress

◆ PrimaryPhoneNumber

◆ PropertyBaths

◆ PropertyBeds

◆ PropertyCity

◆ PropertyListingStatus

◆ PropertyListPrice

◆ PropertyMlsId

◆ PropertyPhotoUrl

◆ PropertyState

◆ PropertyStreetAddress

◆ PropertyUrl

◆ PropertyZip

◆ SearchCity

◆ SearchMaxLotSize

◆ SearchMaxPrice

◆ SearchMaxSqFt

◆ SearchMaxYearBuilt

◆ SearchMinBaths

◆ SearchMinBeds

◆ SearchMinLotSize

◆ SearchMinPrice

◆ SearchMinSqFt

◆ SearchMinYearBuilt

◆ SearchPropertyTypes

◆ SearchState

◆ SearchZip

◆ SecondaryEmailAddress

◆ SecondaryPhoneNumber