Product Associations

deleted

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

API Image API

note

Event Info: This is a human readable note about the event that will be meaningful to the agent.

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

attendees

Event Info: Contacts that are in Engage and will attend the event. This is a comma separated list of contacts that have already been added through the MoxiWorks Platform API who will be present at the referenced event. (Use IDs from your system – i.e. partner_contact_id from Contact Create ).
Engage Image Engage

partner_event_id

Event Info: This is the unique identifer you use in your system that has been associated with the Event that you are creating. This data is required and must be a unique key.
API Image API

event_subject

Event Info: Event title, or other short description about this event.
Engage Image Engage

event_location

Event Info: Location information for the event, such as an address or building title.
Engage Image Engage

send_reminder

Event Info: Whether to send a reminder about the event to attendees before the event starts.
Engage Image Engage

remind_minutes_before

Event Info: If a reminder is being sent, this will allow the user control of when it sends.
Engage Image Engage

event_start

Event Info: This is the Unix timestamp representing the start time of the Event that you are creating. This data is required and must be a valid Unix timestamp.
Engage Image Engage

event_end

Event Info: This is the Unix timestamp representing the end time of the Event that you are creating. This data is required and must be a valid Unix timestamp.
Engage Image Engage

all_day

Event Info: Calendar event associates as an all day event if true is passed.
Engage Image Engage

date_start

Event Info: This is the earliest time that you are searching for an Event to be in. This data is required and must be a Unix timestamp before date_end.
Engage Image Engage

date_end

Event Info: This is the latest time that you are searching for an Event to be in. This data is required and must be a Unix timestamp before date_end.
Engage Image Engage

date

Event Info: Any event Event whose duration spans or falls within this day will be included in the results for this day. This is a string representing a date in MM/DD/YYYY format.
Engage Image Engage

events

Event Info: All events that fall on the selected date within the Engage calendar. This is the payload of Event objects that fall on this day. If no Event objects span this duration, then the events array will be emtpy.
Engage Image Engage