Product Associations

deleted

General Info: In relation to the delete request submitted, this will indicate whether that request was successful.

API Image API

messages

General Info: This is an arrray of strings. Any messages associated with the delete request status will be contained in this array.

API Image API

note

Contact Info: This is a string which reflects the partner created notes. Any Notes added here will be displayed to the agent in an Activity Log record. Any HTML formatting included will be stripped from the note attribute’s data. This text field is limited to 3k.
API Image API
Engage Image Engage

company

Contact Info: The name of the company associated with the Contact record.
Engage Image Engage

spouse_or_partner

Contact Info: This represents the spouse or partner associated with the contact record.
Engage Image Engage

category_names

Contact Info: Related to groups in Engage, and will also correspond to the synced email account’s groups or categories.
Engage Image Engage

email_address

Contact Info: An email address associated with the Contact record.
Engage Image Engage

result

Contact Info: The resulting Contact object associated with this Delete request.
API Image API

moxi_works_contact_id

General Info: This will be an RFC 4122 compliant UUID, and is the same as the moxi_works_contact_id attribute of the Contact response.

Engage Image Engage

timestamps_only

General Info: If supplied then the results will exclude all data except primary identifiers and a unix timestamp (last_updated) & iso8601 timestamp (modification_timestamp) of the last time this record was updated.

API Image API

partner_contact_id

General Info: This is the unique identifer used in the system that will be connecting to the MoxiWorks platform.

API Image API

home_zip

Contact Info: The zip code of the contact’s home address.
Engage Image Engage

home_country

Contact Info: The country of the contact’s home address.
Engage Image Engage

is_not_lead

Contact Info: If the created Contact record is not for a lead set this to true. By default this is false.
API Image API

skip_agent_notification

Contact Info: If the created Contact record should be treated as a lead but it is not desired that the agent should receive an email or text that they have received a lead.
API Image API

job_title

Contact Info: The contact’s professional job title.
Engage Image Engage

agent_uuid

General Info: This will be an RFC 4122 compliant UUID. If data is being pulled from The MoxiWorks Platform and integrating with your own system in a managed or automated fashion, then using agent_uuid request attribute is preferable. It is guaranteed to be unique and to never change for the lifetime of the account.

Roster Image Roster

status

General Info: This will indicate the status of the submitted request / call.

API Image API

occupation

Contact Info: The contact’s profession.
Engage Image Engage

moxi_works_agent_id

General Info: If you have already existing agent data, agent accounts and your own user interface that agents can use to integrate your account with their MoxiWorks Platform account then you should use the moxi_works_agent_id request attribute. It is intended for use cases where integration is managed by end-user interaction.

API Image API

source_agent_id

General Info: If you have access to agent data from the same company source that MoxiWorks uses as an upstream data source then you should use the source_agent_id request attribute. This identifier will be unique only within the scope of a given company or parent_company, and must be used in conjunction with the moxi_works_company_id or parent_company_id request attributes. Please email partners@moxiworks.com for clarification about this request attribute.

API Image API

moxi_works_company_id

General Info: MoxiWorks Plaform Company entities are your entry-point for determining the established relationships for your organization to companies on the MoxiWorks Platform and for accessing data about those companies. Many requests require a moxi_works_company_id, which can be derived from the Company Index endpoint.

API Image API
Roster Image Roster

parent_company_id

General Info: This provides for a broad scope by which partners may be afforded permissions to perform MoxiWorks Platform actions, in scenarios where a partner does business with a parent company in the MoxiWorks System. It also provides broad scope under which agents may be looked up using the source_agent_id request attribute in many scenarios across different MoxiWorks Platform endpoints and actions.

API Image API
Roster Image Roster

first_name

Contact Info: The first name of the contact.
Engage Image Engage

last_name

Contact Info: The last name of the contact.
Engage Image Engage

primary_email_address

Contact Info: This is the email address that should be used first. If provided, the address must conform to RFC 3696. This value will be null if no data is available for this attribute. This attribute should not be used in conjunction with the email_addresses attribute.
Engage Image Engage

secondary_email_address

Contact Info: This is the email address that should be used as an alternate. If provided, the address must conform to RFC 3696. This value will be null if no data is available for this attribute. This attribute should not be used in conjunction with the email_addresses attribute.
Engage Image Engage

email_addresses

Contact Info: These email addresses correspond to agent created Contact entities. Only phone fields present in this Contact record will be returned. [key, address]
Engage Image Engage

updated_since

Contact Info: Paged responses of all Contact objects updated after this Unix timestamp will be returned in the response.
API Image API

page_number

General Info: For queries with multi-page responses, use the page_number parameter to return data for specific pages. Data for page 1 is returned if this parameter is not included. Use this parameter if total_pages indicates that there is more than one page of data available.

API Image API

search_max_lot_size

Contact Info: The maximum lot size used in the listing search criteria.
Engage Image Engage

contact_name

Contact Info: This is the full name of the contact you are creating a Contact record for.This is the full name of the contact you are creating a Contact record for.
Engage Image Engage

primary_phone_number

Contact Info: This is the phone number that should be used first as a phone contact method, and displays as the primary phone number.
Engage Image Engage

secondary_phone_number

Contact Info: This is the phone number that should be used as an alternate phone contact method, and displays as the alternate phone number.
Engage Image Engage

moxi_works_lead_source_id

Contact Info: This is used to keep track of the original lead source for this Contact record. This field will not be displayed in MoxiEngage, and is for the parter’s own tracking purposes. This key will be associated with valid moxi_works_lead_source_id. Send a LeadSource index request for a full list of applicable lead sources and their ids.
API Image API

original_lead_source

Contact Info: This is used to keep track of the original lead source for this Contact record, if different than the lead source associated with the moxi_works_lead_source_id.
API Image API

gender

Contact Info: 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.
Engage Image Engage

label_name

Contact Info: This is the name used to address the contact when creating mailing labels for the contact associated with this Contact record.
Engage Image Engage

home_street_address

Contact Info: The contact’s home address street, including number and any suite / apartment number information.
Engage Image Engage

home_city

Contact Info: The city of the contact’s home address.
Engage Image Engage

home_state

Contact Info: The state of the contact’s home address.
Engage Image Engage

property_url

Contact Info: This should be a valid URL for a property of interest within the system that can be viewed by the agent.
Engage Image Engage

property_mls_id

Contact Info: This is data about a property that the contact has shown interest in (property of interest) - Specifically the MLS ID of that property.
Engage Image Engage

property_street_address

Contact Info: This is the street address of the property of interest, including number and suite/apartment number information.
Engage Image Engage

property_city

Contact Info: This is the city in which the property of interest exists.
Engage Image Engage

property_state

Contact Info: This is the state or province in which the property of interest exists.
Engage Image Engage

property_zip

Contact Info: This is the postal code in which the property of interest exists.
Engage Image Engage

property_beds

Contact Info: This is the number of bedrooms in the property of interest.
Engage Image Engage

property_baths

Contact Info: This is the number of bathrooms in the property of interest.
Engage Image Engage

property_list_price

Contact Info: This is the list price of the property of interest.
Engage Image Engage

property_listing_status

Contact Info: This is 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 generally accepted MLS status for a listing should be provided.
Engage Image Engage

property_photo_url

Contact Info: This is the URL to an image displaying the property of interest.
Engage Image Engage

search_city

Contact Info: The city / locale used in the listing search criteria.
Engage Image Engage

search_state

Contact Info: The state / region used in the listing search criteria.
Engage Image Engage

search_zip

Contact Info: The zip / postal code used in the listing search criteria.
Engage Image Engage

search_min_baths

Contact Info: The minimum bathrooms used in the listing search criteria.
Engage Image Engage

search_min_beds

Contact Info: The minimum bedrooms used in the listing search criteria.
Engage Image Engage

search_min_price

Contact Info: The minimum price used in the listing search criteria.
Engage Image Engage

search_max_price

Contact Info: The maximum price used in the listing search criteria.
Engage Image Engage

search_min_sq_ft

Contact Info: The minimum square feet of the total living area used in the listing search criteria.
Engage Image Engage

search_max_sq_ft

Contact Info: The maximum square feet of the total living area used in the listing search criteria.
Engage Image Engage

search_min_lot_size

Contact Info: The minimum lot size used in the listing search criteria.
Engage Image Engage

search_min_year_built

Contact Info: The minimum allowable year built used in the listing search criteria.
Engage Image Engage

search_max_year_built

Contact Info: The maximum allowable year built used in the listing search criteria.
Engage Image Engage

search_property_types

Contact Info: 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.
Engage Image Engage

websites

Contact Info: Websites should be submitted as a json array of objects. Each object should include website prioritized ‘rank’ and ‘value’. The number of website fields available for update for a given Contact record depends on the agent email client type.
API Image API
Engage Image Engage

birthday

Contact Info: This represents the Special Date - birthday for the associated contact.
Engage Image Engage

home_purchase_anniversaries

Contact Info: This represents the Special Date(s) - house-iversary for the associated contact.
Engage Image Engage

is_deleted

Contact Info: Will be true if this Contact has been deleted from the Agents contacts.
API Image API

middle_name

Contact Info: This is the middle name of the contact associated with this Contact record.
Engage Image Engage

suffix

Contact Info: This is the generational suffix of the name of the contact associated with this Contact record. Supported suffixes are II III IV JR JR.
Engage Image Engage

phone_numbers

Contact Info: These phone numbers correspond to agent created Contact entities. Only phone fields present in this Contact record will be returned.
Engage Image Engage

is_new_contact

Contact Info: Indicates if the contact was recently added to the Agent’s database.
Engage Image Engage

anniversary

Contact Info: Wedding anniversary of the contact.
Engage Image Engage

home_purchase_anniversary

Contact Info: This represents a Special Date - house-iversary for the associated contact.
Engage Image Engage

social_media_profiles

Contact Info: The social media profiles that are associated with the contact. [key, url]
Engage Image Engage

groups

Contact Info: Related to groups in Engage, and will also correspond to the synced email account’s groups or categories.
Engage Image Engage

moxi_works_origin_lead_source_id

Contact Info: This is used to keep track of the original lead source for this Contact record. This field will not be displayed in MoxiEngage, and is for the parter’s own tracking purposes. This key will be associated with valid moxi_works_lead_source_id. Send a LeadSource index request for a full list of applicable lead sources and their ids.
API Image API

phone_number

Contact Info: A phone number associated with the Contact record.
Engage Image Engage

only_business_contacts

Contact Info: Whether to only include Contact records for contacts that are neither considered personal contacts nor work collaborators in the payload response. By default all Contact records will be returned. Use the personal_contact and collaborator response attributes to determine the status of any given contact.
API Image API

total_pages

Contact Info: If there is more than one page of Contact objects to return, total_pages will denote how many pages of Contact objects there are to be returned fo the current query. Subsequent pages can be returned by including the page_number parameter in your API request.
API Image API

contacts

Contact Info: This array contains the payload from the request query. Any found Contact objects matching the query will be returned as Contact objects in the response. [see, documentation]
Engage Image Engage