Product Associations

body

General Info: This can be any arbitrary plain-text string which would be practical for the agent to see in the history of events associated with a Contact. It must be greater than 0 and must be less than 5000 characters (including white space).

Engage Image Engage

title

General Info: This represents the title of the entity this attribute is associated with.

Engage Image Engage

agent_action

ActionLog Info: This is the human readable plain-text string which will be presented to the agent as the heading of the ActionLog entry. This can be any short, descriptive sentence which would be practical for the agent to see in the history of events associated with a Contact.
Engage Image Engage

agent_action_address

ActionLog Info: If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the street address of the agent_action.
Engage Image Engage

agent_action_address2

ActionLog Info: If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the additonal street address info of the agent_action.
Engage Image Engage

agent_action_city

ActionLog Info: If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the city or locale of the agent_action.
Engage Image Engage

agent_action_state

ActionLog Info: If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the state or province related info of the agent_action.
Engage Image Engage

agent_action_zip

ActionLog Info: If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the postal code of the agent_action.
Engage Image Engage

timestamp

ActionLog Info: This is the Unix timestamp for the creation time of the ActionLog entry.
Engage Image Engage

moxi_works_action_log_id

ActionLog Info: This is the MoxiWorks Platform ID of the ActionLog entry to be deleted. This will be an RFC 4122 compliant UUID.
API Image API
Engage Image Engage

date_min

ActionLog Info: Only ActionLog records created later than this Unix timestamp will be included in the query. The upper bound of the time slice will be the 90 days higher than date_min value or the value of the the date_max; whichever is lower. If no timestamps are provided, ActionLogs from the last 90 days will be retrieved. The maximum timeframe for data is 90 days. date_min and date_max should be set in 90 day increments to retrieve the data from a specific historical point.
API Image API

date_max

ActionLog Info: Only ActionLog records created earlier than this Unix timestamp will be included in the query. Should be no higher than 90 days past the date_min attribute if it is provided. The maximum timeframe for data is 90 days. date_min and date_max should be set in 90 day increments to retrieve the data from a specific historical point.
API Image API

actions

ActionLog Info: This is an Array containing any ActionLog entries found for the Index request - [moxi_works_action_log_id, type, timestamp, log_data].
API Image API
Engage Image Engage

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

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

status

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

API Image API

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