Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
locations

Create a location and replace its Company Attributes with the payload

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

post/api/serviceworkforce/processes/locations/custom_attributes

Request body

Example request

{
  "locationPayload": {
    "name": "Downtown Store",
    "description": "Main branch"
  },
  "customAttributesPayload": [
    {
      "attribute": "location_type",
      "value": "Retail"
    },
    {
      "attribute": "has_parking",
      "value": true
    }
  ]
}

Response

Created Successfully