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
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
Roster
name
General Info: This name attribute is shared between several endpoints, and generally represents the full name of the entity.
Roster
uuid
Team Info: This is the MoxiWorks Platform ID of the Team. This will be an RFC 4122 compliant UUID.
Roster
city
Team Info: The city the team is in.
Roster
state
Team Info: The state or provice the team is in.
Roster
zipcode
Team Info: The postal code the team is in.
Engage
logo_url
Team Info: URL to a logo for the team.
Roster
address2
Team Info: The suite or team number of the team. This can be null if there is no data for this attribute.
Roster
alt_phone
Team Info: Alternate phone number for the team. This should be considered second in priority to phone_number.
Roster
email
Team Info: This is the team’s main email address. This email address should be considered the email address the team would prefer to be contacted by.
Roster
phone
Team Info: This is the team’s main phone number. This number should be considered the number the team would prefer to be contacted by.
Roster
description
Team Info: Description of the team. This can contain embedded HTML tags.
Engage
moxi_works_team_id
Team Info: A valid MoxiWorks Team ID. Use Team Index Endpoint for a list of all Team objects associated with a Company or use the moxi_works_team_id attribute returned in an Agent response.
API
address1
Team Info: The street address of the team.
Roster
fax
Team Info: This is the team’s fax phone number.
Roster
photo_url
Team Info: URL to an image of the team.
Roster
alt_email
Team Info: Alternate email for the team. This should be considered second in priority to email.
Roster
website_url
Team Info: Team’s website url.
Roster
active
Team Info: Whether this team is active.
API
Roster