Product Associations

email_address

EmailCampaign Info: The email address for the EmailSubscription.
Engage Image Engage

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

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

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

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

subscription_type

EmailCampaign Info: This is a unique, internally defined string per EmailSubscription type. Documentation of available subscription_type responses is outside the scope of this documentation. If you need help determining available types, please email partners@moxiworks.com.
Engage Image Engage

subscribed_at

EmailCampaign Info: Unix timestamp representing when the EmailSubscription that is associated with the Contact for the supplied partner_contact_id was initiated.
API Image API

created_by

EmailCampaign Info: This is a string representing the actor responsible for the subscription initiation.
Engage Image Engage

area

EmailCampaign Info: A string representing a geographic area that the EmailSubscription regards.
Engage Image Engage

last_sent

EmailCampaign Info: This is a Unix timestamp representing the point in time that the last EmailSubscription message was sent.
Engage Image Engage

next_scheduled

EmailCampaign Info: This is a Unix timestamp representing the point in time that the next EmailSubscription message will be sent.
Engage Image Engage

created_at

EmailCampaign Info: Unix timestamp representing when the EmailSubscription was created.
Engage Image Engage

unsubscribed_at

EmailCampaign Info: Unix timestamp representing when the EmailSubscription that is associated with the Contact for the supplied partner_contact_id was unsubscribed.
Engage Image Engage

unsubscribed_by

EmailCampaign Info: Who the EmailSubscription that is associated with the Contact for the supplied partner_contact_id was unsubscribed by.
Engage Image Engage

listed

EmailCampaign Info: Boolean representing whether email subscription is a listing announcement for listed homes.
Engage Image Engage

sold

EmailCampaign Info: Boolean representing whether email subscription is a listing announcement for sold homes.
Engage Image Engage

zipcode

EmailCampaign Info: Related to neighborhood news subscription.
Engage Image Engage

nn_subscription_type

EmailCampaign Info: Type of neighborhood email subscription. This can either be “quick” or “custom”.
Engage Image Engage

nn_min_price

EmailCampaign Info: For “custom” neighborhood email subscription , search filter with min price.
Engage Image Engage

nn_max_price

EmailCampaign Info: For “custom” neighborhood email subscription , search filter with max price.
Engage Image Engage

nn_min_beds

EmailCampaign Info: For “custom” neighborhood email subscription , search filter with min number of bedrooms.
Engage Image Engage

nn_max_beds

EmailCampaign Info: For “custom” neighborhood email subscription , search filter with max number of bedrooms.
Engage Image Engage

nn_min_baths

EmailCampaign Info: For “custom” neighborhood email subscription , search filter with min number of bathrooms.
Engage Image Engage

nn_min_sqft

EmailCampaign Info: For “custom” neighborhood email subscription , search filter with min square feet
Engage Image Engage

nn_max_sqft

EmailCampaign Info: For “custom” neighborhood email subscription , search filter with max square feet.
Engage Image Engage

nn_property_type

EmailCampaign Info: For “custom” neighborhood email subscription, property_type is selected in the search filter. This value can be either Residential, Condominium, Manufactured Homes, Multi-family, or Townhouse.
Engage Image Engage