v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

locations

Update a location and replace its Company Attributes with the payload

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

patch/api/serviceworkforce/processes/locations/{locationUuid}/custom_attributes

Path parameters

locationUuidstring uuid required

UUID of the location to update

Request body

Example request

{
  "locationPayload": {
    "description": "Updated description"
  },
  "customAttributesPayload": [
    {
      "attribute": "location_type",
      "value": "Retail"
    },
    {
      "attribute": "has_parking",
      "value": false
    }
  ]
}

Response

Updated Successfully