v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

locationGroups

Create a location group and replace its Company Attributes with the payload

Creates a Location Group and upserts its Company Attributes in one request. The provided customAttributesPayload replaces the entire set of attributes attached to the location group: omit the field to create the location group without company attributes; provide an empty array ([]) to create the location group with no attributes. Values must match the attribute data type configured for the company attribute.

post/api/serviceworkforce/processes/locationGroups/custom_attributes

Request body

Example request

{
  "locationGroupPayload": {
    "name": "Regional Hub",
    "description": "Distribution center"
  },
  "customAttributesPayload": [
    {
      "attribute": "location_group_type",
      "value": "Distribution"
    }
  ]
}

Response

Created Successfully