Product Associations

office_id

General Info: This is the MoxiWorks Platform ID of the office for the agent. This will be an RFC 4122 compliant UUID.

API Image API
Roster Image Roster

moxi_works_office_id

General Info: This will be an RFC 4122 compliant UUID.

API Image API
Roster Image Roster

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

name

General Info: This name attribute is shared between several endpoints, and generally represents the full name of the entity.

Present Image Present

image_logo

Brand Info: This is the logo associated with the Brokerage or Company.
Present Image Present

cma_authoring_color

Brand Info: Within a Presentation, this will be the accent color.
Present Image Present

background_color

Brand Info: Within a Presentation, this will be the background color of a page.
Present Image Present

background_font_color_primary

Brand Info: Within a Presentation, this is the font color intended to overlay the background_color attribute.
Present Image Present

button_background_color

Brand Info: Within a Presentation, this is the background color of associated buttons.
Present Image Present

button_font_color

Brand Info: Within a Presentation, this is the font color intended to overlay the button_background_color attribute.
Present Image Present

copyright

Brand Info: Within a Presentation, this will be the copyright notice information.
Present Image Present

display_name

Brand Info: Within a Presentation, this is the name of the Brokerage or Company as displayed to the consumer.
Present Image Present

email_element_background_color

Brand Info: This is specific to the background color that displays when sending an email from Present, for elements outside of the email body.
Engage Image Engage
Present Image Present

email_background_font_color

Brand Info: The font color for font that overlays email_element_background_color.
Engage Image Engage
Present Image Present

image_cma_pdf_logo_header

Brand Info: Within a Presentation - specifically Print (PDF) format, this will be the Brokerage or Company logo that displays.
Present Image Present

image_email_logo_alt

Brand Info: Related to sent emails, this will be the Brokerage or Company logo as shown in email header.
Present Image Present

image_favicon

Brand Info: Within a presentation, this will be the favicon that displays related to the Brokerage or Company.
Present Image Present

image_pres_cover_logo

Brand Info: Within a Presentation - specifically web view, this will be the Brokerage or Company logo.
Present Image Present

pres_block_background_color

Brand Info: Within a Presentation - specifically web view, this is the background color that displays.
Present Image Present

pres_block_text_color

Brand Info: Within a Presentation - specifically web view, this is the font color for related text.
Present Image Present