Wix Answers Help Center
Teams API
Team APIs enable you to manage agent teams. Teams are used for informational and reporting purposes only, and represent organizational entities, such as support for different products. Each agent can be assigned to one team.
Agents can also be assigned to groups. For example, you might manage a large number of agents, each of whom speaks one or more languages. Your team then can include several groups, each of which is assigned to the queue relevant for that language. Agents who speak multiple languages can be assigned to multiple groups. See Groups API.
Agents can also be assigned to groups. For example, you might manage a large number of agents, each of whom speaks one or more languages. Your team then can include several groups, each of which is assigned to the queue relevant for that language. Agents who speak multiple languages can be assigned to multiple groups. See Groups API.
Configure Teams
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/teams
Configure your tenant's teams. The list that you upload here entirely replaces any previous teams configuration. Wix Answers deletes any teams not in the list.
- Authorization: Requires agent authorization token and permission MANAGE_TEAM_MEMBERS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: List of Team Objects
Notes:
- Each team must include the team name.
- If you do not also include the team id (GUID), Wix Answers creates a new team with the name and assigns it a new ID. Note: All team names must be unique. This means that you cannot create a new team "Team1" if an existing team already has the name "Team1".
- If you include a team id, Wix Answers leaves the existing team as is.
- Wix Answers deletes any existing teams that you do not include in the list. Agent objects of agents assigned to the deleted teams continue to link to the old team GUIDs, but the deleted team names do not appear in the UI. When an agent is assigned to a new team, the new team assignment overrides any existing assignment.
Payload Params | Description | Type | Required |
|---|---|---|---|
teams | List of teams to create See above notes. | List of Team objects Max 1000 teams. | ✓ |
Payload Example:
1 2 3 4 5 6 7 8PUT https://<account_subdomain>.wixanswers.com/api/v1/teams { "teams": [ {"name": "Team1"}, //Create new team {"name": "Team2", "id": "d367738e-368e-41fe-9289-1a5cbbc3c239"}, // Maintain existing team ... ], }
Get Team Information
Get information about a team.
- Authorization: Requires agent authorization token and permission FETCH_TEAM_MEMBERS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Team Object
Request Example:
1GET https://<account_subdomain>.wixanswers.com/api/v1/teams/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa
Get All Teams
GET https://<tenant_subdomain>.wixanswers.com/api/v1/teams
Get the list of teams.
- Authorization: Requires agent authorization token and permission FETCH_TEAM_MEMBERS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: List of Team Objects
Request Example:
1GET https://<account_subdomain>.wixanswers.com/api/v1/teams
Was this article helpful?