v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

locationGroups

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

Updates a Location Group and upserts its Company Attributes. The provided customAttributesPayload replaces the entire set of attributes attached to the location group: omit the field to leave existing attributes unchanged; provide an empty array ([]) to remove all attributes from the location group. Values must match the attribute data type configured for the company attribute.

patch/api/serviceworkforce/processes/locationGroups/{locationGroupUuid}/custom_attributes

Path parameters

locationGroupUuidstring uuid required

UUID of the locationGroup to update

Request body

Example request

{
  "locationGroupPayload": {
    "description": "Updated description"
  },
  "customAttributesPayload": [
    {
      "attribute": "location_group_type",
      "value": "Distribution"
    }
  ]
}

Response

Updated Successfully