Update Location
PUT request to update location details.
The identifier for the location to be updated is included in the JSON body.
This is a partial update and only those details specified in the JSON body will be updated.
The updated address for the location can be specified as just the longitude and latitude coordinates or an address (roadNumber, road, city, postcode, country).
The type of a location can be updated from a circle to a polygon or from a polygon to a circle, by specifying the the geofence for the location as either:
The radius for the circle must be between 0.001 and 1.
The geofence boundary is closed by automatically linking the first longitude and latitude pair to the last longitude and latitude pair specified.
The geofence for a location can overlap the geofence for another location.
The geofence for this location can overlap up to 5 locations.
The location details are in a JSON object included in the HTTP body.
Ensure you have set the content-type of the request body to “application/json;charset=UTF-8”.
JSON object structure for the address specified as longitude and latitude:
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
Body
Unique name for the location.
Name of an existing location category.
Address object of the location.
Radius (in km) of the location boundary.
Must be between 0.001 and 1.
Must be specified if polygon details are not specified.
Array of points that define the geo-fence boundary of the polygon.
Must be specified if radius is not specified.
A valid email address for this location.
Cannot be more than 50 characters.
Notes for this location, Cannot be more than 140 characters.
Response
Successful operation
Unique name for the location.
Name of an existing location category.
Address object of the location.
Radius (in km) of the location boundary.
Must be between 0.001 and 1.
Must be specified if polygon details are not specified.
Array of points that define the geo-fence boundary of the polygon.
Must be specified if radius is not specified.
A valid email address for this location.
Cannot be more than 50 characters.
Notes for this location, Cannot be more than 140 characters.
