Locations API

Location APIs enable you to manage agent locations. Locations are used for informational and reporting purposes only. and represent the physical locations of agents, such as floors, cities, or countries. Each agent can be assigned to one location.

Configure Locations

PUT https://<tenant_subdomain>.wixanswers.com/api/v1/locations

Configure your tenant's locations. The list that you send here entirely replaces any previous locations configuration. Wix Answers deletes any locations not in the list.
Notes:
  • Each location must include the location name.
  • If you do not also include the location id (GUID), Wix Answers creates a new location with the name and assigns it a new ID.  Note: All location names must be unique. This means that you cannot create a new location "Location1" if an existing location already has the name "Location1".
  • If you include a location id, Wix Answers leaves the existing location as is.
  • Wix Answers deletes any existing locations that you do not include in the list. Agent objects of agents assigned to the deleted locations continue to link to the old location GUIDs, but the deleted location names do not appear in the UI. When an agent is assigned to a new location, the new location assignment overrides any existing assignment.
Payload Params
Description
Type
Required
locations
List of locations to create

See above notes.
List of Location objects

Max 1000 locations.
✓
Payload Example:
1
2
3
4
5
6
7
8
PUT https://<account_subdomain>.wixanswers.com/api/v1/locations
{
    "locations": [
        {"name": "Location1"}, //Create new location
        {"name": "Location2", "id": "d367738e-368e-41fe-9289-1a5cbbc3c239"}, // Maintain existing location
        ...
    ],
}

Get Location Information

GET https://<tenant_subdomain>.wixanswers.com/api/v1/locations/{location GUID}

Get information about a location.
Request Example:
1
GET https://<account_subdomain>.wixanswers.com/api/v1/locations/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa

Get All Locations

GET https://<tenant_subdomain>.wixanswers.com/api/v1/locations
Get the list of locations.
Request Example:
1
GET https://<account_subdomain>.wixanswers.com/api/v1/locations
IN THIS ARTICLE