Sign in
Public
Locations

Update a location

patch/v1/public/locations/{locationId}

Path parameters

locationIdstring required

Request body

namestring

the name of the location

codestring

A human readable ID that can be use has an ID for other API calls. The code is also used to map a location to an external system structural element.

externalIdstring

A unique UID or a human readable ID that can be use has an ID for other API calls. The externalId can also be used to map a location to an external system structural element.

abbrevstring

an abbreviation text, used in various place in the application where space is tight. Like on shifts of the schedule view.

addressstring

the full address of the location

radiusInMnumber

a radius in meter around the location center point where a punch entry is considered valid

geoLocationEnabledboolean

when true a punch is valid if the location of the user is within the location coordinates and radius

latitudenumber

the latitude coordinate of the location

longitudenumber

the longitude coordinate of the location

customobject

To set custom fields to a location. You can pass a json objet where the values are string. Will merge with previous values.

Example request

{
  "name": "Headquarters",
  "abbrev": "HQ",
  "custom": {
    "field1": "value1",
    "field2": "value2"
  }
}

Response

uidstring required

unique location id

status'deleted' | 'active' required

Location status

namestring required

Location name

abbrevstring

Location abbreviation

codestring

The location code. The code is often used as a mapping value between Evolia and an external system

externalIdstring

The unique location externalId. The externalId is often used as a mapping value between Evolia and an external system

addressstring

Location address

coordinatesstring[]

0: Longitude, 1: Latitude

subLocationIdsstring[]

Array of sub location UIDs linked to the location

subLocationsstring[]

Array of sub locations

customobject nullable

An optional object of custom properties. Current implementation only support string values

Example response

{
  "custom": {
    "key1": "value1",
    "key2": "value2"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.