SalesTeam

In Maximizer, opportunities can be assigned to predefined sales teams configured by the system administrator within the Administrator module. This feature enables structured delegation by associating opportunities with specific teams, where access permissions—such as view and edit rights—are controlled at the team member level. Sales team configurations, including membership and access controls, are centrally managed in the Administrator settings.

Sales team are composed of the following types of members:

• Team leader – In a team, one person is designated as a team
leader who has the right to make any changes to the
opportunity. The team leader can change the status of
opportunities.

• Team member – Regular team members can update the basic
and user-defined fields in an opportunity, but they do not have
the right to change the status of the opportunity. The member’s
role is to perform the tasks the team leader assigns. Team
members can modify the tasks from the Calendar and Hotlist
pages.

• Team member with edit rights – Team members can be
granted edit rights for opportunities, giving the team member
the same abilities as the team leader.

HowTo's

Get Top 10 Sales Teams

Use the AbEntryRead method to search for Address Book entries in the database.

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "SalesTeam": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "DisplayValue": 1
            }
        },
        "Criteria": {
            "SearchQuery": {},
            "Top": 10
        }
    }
}

Get Members of Sales Team

Use the AbEntryRead method to search for Address Book entries in the database.

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "SalesTeam": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Members": {
                    "Key": {
                        "Uid": 1,
                        "Value": 1,
                        "DisplayValue": 1
                    },
                    "Role": {
                        "Key": 1,
                        "DisplayValue": 1
                    },
                    "Right": {
                        "Key": 1,
                        "DisplayValue": 1
                    },
                    "DisplayValue": 1
                }
            }
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$EQ": "U2FsZXNUZWFtCTM=" 
                }
            }
        }
    }
}

Add user to SalesTeam

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "SalesTeam": {
        "Data": {
            "Key": "U2FsZXNUZWFtCTM=",// Mandatory
            "DisplayName": "TestSalesTeamUpdated",
            "Members": [
                {
                    "Key": {
                        "Uid": "USER4"// Mandatory
                    },
                    "Role": 0,
                    "Right": 1
                }
            ]
        },
        "Options": {
            "Append": true // Used to add a new Team member in the existing Team
        }
    }
}

Remove user from SalesTeam

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "SalesTeam": {
        "Data": {
            "Key": "U2FsZXNUZWFtCTM=",// Mandatory
            "DisplayName": "TestSalesTeamUpdated",
            "Members": [
                {
                    "Key": {
                        "Uid": "USER4"// Mandatory
                    }
                }
            ]
        },
        "Options": {
            "Remove": true
        }
    }
}

MetaData

Read SalesTeam metadata (simple)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": 1
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/SalesTeam"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Read SalesTeam metadata (more)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Alias": 1,
                "Type": 1,
                "Name": 1,
                "AppliesTo": 1,
                "Sortable": 1,
                "Nullable": 1,
                "Assignable": 1,
                "Queryable": 1,
                "Mandatory": 1,
                "Attributes": 1,
                "HasOption": 1,
                "DisplayValue": 1,
                "Inactive": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/SalesTeam"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

SalesTeam CRUD

SalesTeam - Read

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "SalesTeam": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "DisplayName": 1,
                "Members": {
                    "Key": {
                        "Uid": 1,
                        "Value": 1,
                        "DisplayValue": 1
                    },
                    "Role": {
                        "Key": 1,
                        "DisplayValue": 1
                    },
                    "Right": {
                        "Key": 1,
                        "DisplayValue": 1
                    },
                    "DisplayValue": 1
                }
            }
        },
        "Criteria": {
            "SearchQuery": {},
            "Top": 3
        }
    }
}

SalesTeam - Create

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "SalesTeam": {
        "Data": {
            "Key": null,
            "DisplayName": "TestSalesTeam", // Mandatory
            "Members": [
                {
                    "Key": {
                        "Uid": "USER1" // Mandatory
                    },
                    // Reminder: a SalesTeam can have only one Leader
                    "Role": 1, // 1 = Leader, 0 = Member
                    "Right": 0 // 0 = Edit, 1 = Audit, 2 = Standard
                },
                {
                    "Key": {
                        "Uid": "USER2"
                    },
                    "Role": 0,
                    "Right": 2
                },
                {
                    "Key": {
                        "Uid": "USER3"
                    },
                    "Role": 0,
                    "Right": 1
                }
            ]
        }
    }
}

SalesTeam - Update

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "SalesTeam": {
        "Data": {
            "Key": "U2FsZXNUZWFtCTE2MTQ4MDQwMDA=",// Mandatory
            "DisplayName": "TestSalesTeamUpdated"
        }
    }
}

SalesTeam - Delete

// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
    "SalesTeam": {
        "Data": {
            "Key": "U2FsZXNUZWFtCTE2MTQ4MDQwMDA="// Mandatory
        }
    }
}