Wix Answers Help Center
Groups API
The groups API enables you to manage agent groups. You associate agents with groups and can assign tickets or article tasks to groups (in addition to specific agents).
Agents can also belong to a team; see Teams API.
Agents can also belong to a team; see Teams API.
Add Group
POST https://<tenant_subdomain>.wixanswers.com/api/v1/groups
Add a group.
Add a group.
- Authorization: Requires agent authorization token and permission MANAGE_TEAM_MEMBERS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Group object
Payload Params | Description | Type | Required |
---|---|---|---|
name | Group name The name must be unique in the tenant. | String | ✓ |
settings | Group settings. Structure of: * avatarPath (String): Path to the group's icon. Can be an empty string, in which case a default image is used. | Structure | ✓ |
Payload Example:
1 2 3 4 5 6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/groups { "name": "Group 1", "settings": { "avatarPath": "" } }
Get Group (including members)
GET https://<tenant_subdomain>.wixanswers.com/api/v1/groups/{group GUID}
Get an agent group's information.
Get an agent group's information.
- Authorization: Requires agent authorization token and permission FETCH_TEAM_MEMBERS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Group object
Request Example:
1
GET https://<account_subdomain>.wixanswers.com/api/v1/groups/e932c0a3-6e9b-43cf-b3a9-90f6ee6a5b06
Get Groups
GET https://<tenant_subdomain>.wixanswers.com/api/v1/groups
Get list of all agent groups.
Get list of all agent groups.
- Authorization: Requires agent authorization token and permission FETCH_TEAM_MEMBERS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: List of Group objects
Request Example:
1
GET https://<account_subdomain>.wixanswers.com/api/v1/groups
Add Agent to Group
POST https://<tenant_subdomain>.wixanswers.com/api/v1/groups/{group GUID}/members
Add an agent to a group.
Add an agent to a group.
- Authorization: Requires agent authorization token and permission MANAGE_GROUP_ASSIGMENTS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Group object
Payload Params | Description | Type | Required |
---|---|---|---|
userId | Agent to add to group | ✓ |
Payload Example:
1 2 3 4 5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/groups/e932c0a3-6e9b-43cf-b3a9-90f6ee6a5b06/members { "userId": "77bc8694-5ccf-436c-ab2b-543563a5f425" }
Remove Agent from a Group
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/groups/{group GUID}/members/{agent GUID}
Remove an agent from a group.
Remove an agent from a group.
- Authorization: Requires agent authorization token and permission MANAGE_GROUP_ASSIGMENTS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Group object
Request Example:
1
DELETE https://<account_subdomain>.wixanswers.com/api/v1/groups/e932c0a3-6e9b-43cf-b3a9-90f6ee6a5b06/members/d367738e-368e-41fe-9289-1a5cbbc3c239
Add and Remove Agents From Groups in Bulk
POST https://<tenant_subdomain>.wixanswers.com/api/v1/groups/members
Add and/or remove multiple agents to/from multiple groups.
Add and/or remove multiple agents to/from multiple groups.
- Authorization: Requires agent authorization token and permission MANAGE_GROUP_ASSIGMENTS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: List of processed user GUIDs
Importing a Large Number of Records
To import a large number of group associations, such as your initial database, contact Wix Answers for assistance.
Payload Params | Description | Type | Required |
---|---|---|---|
agentIds | Agent to process If you send an invalid ID, the endpoint fails. Duplicate IDs, and IDs that are/are not already in the group(s), are ignored. | List of user GUIDs Between 1 and 50 agents. | ✓ At least one agent is required. |
unassignedGroupsIds | Groups to remove from agents If you send an invalid or duplicate ID, or if the same ID exists in both assigned and unassigned parameters, the endpoint fails. | List of group GUIDs Up to 10 groups. | |
assignedGroupsIds | Groups to add to agents If you send an invalid or duplicate ID, or if the same ID exists in both assigned and unassigned parameters, the endpoint fails. | List of group GUIDs Up to 10 groups |
Request Example:
1 2 3 4 5 6 7
POST https://<tenant_subdomain>.wixanswers.com/api/v1/groups/members { "agentIds": ["77bc8694-5ccf-436c-ab2b-543563a5f425", "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa"], "assignedGroupIds":["e932c0a3-6e9b-43cf-b3a9-90f6ee6a5b06"] }
Get Group Members
GET https://<tenant_subdomain>.wixanswers.com/api/v1/groups/{group GUID}/members
Get a group's members.
Get a group's members.
- Authorization: Requires agent authorization token and permission FETCH_TEAM_MEMBERS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: List of Agent Objects
Request Example:
1
GET https://<account_subdomain>.wixanswers.com/api/v1/groups/e932c0a3-6e9b-43cf-b3a9-90f6ee6a5b06/members
Update Group
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/groups/{group GUID}
Update a group's information. See Important Information about Updating Using the API.
- Authorization: Requires agent authorization token and permission MANAGE_TEAM_MEMBERS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: Group object
See Add Group for payload information.
Delete Group
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/groups/{group GUID}
Remove all agents from a group and delete the group. After deleting the group, any items associated with the group, such as tasks or tickets, are no longer associated.
Remove all agents from a group and delete the group. After deleting the group, any items associated with the group, such as tasks or tickets, are no longer associated.
- Authorization: Requires agent authorization token and permission MANAGE_TEAM_MEMBERS
- Content type: application/json; charset=utf-8
- Accept: application/json
- Response: None
Request Example:
1
DELETE https://<account_subdomain>.wixanswers.com/api/v1/groups/e932c0a3-6e9b-43cf-b3a9-90f6ee6a5b06
Was this article helpful?