Updates a single geofence

put

https://tracking.hereapi.com/geofences/v2/{geofenceId}

Updates the geofence type, name, description, metadata or definition property. The old geofence will be replaced by the new one, and hence the full set of the geofence properties must be provided in the request body. POI geofence type cannot be changed to circle or polygon and vice versa.

If the update was successful, the response will contain the updated geofence details.

Path Params

geofenceId

uuid

required

ID of the geofence

Query Params

force

boolean

Defaults to false

Tracking offers Geofence Refinement service for some customers. Geofences which have been refined by Tracking cannot be updated without 'force=true' query parameter.

Body Params

type

string

enum

required

The geofence type.

Allowed:

definition

object

required

An object that defines the area of a circular geofence

metadata

object

Metadata JSON object may contain additional customer specific information

name

string

length ≤ 50

A human-readable name of the geofence.

description

string

length ≤ 1000

A description of the area that the geofence encloses and the purpose of the geofence.

Headers

X-Request-Id

uuid

ID used for correlating requests within HERE Tracking. Used for logging and error reporting.

Must be a valid UUIDv4.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/octet-stream

200Successful The geofence definition was updated.

400Bad request The request object is in an incorrect format or has values that are invalid or out of range. If available, further error details are provided in the response body.

401Unauthorized The request did not provide correct authentication details

403Forbidden The account does not have the correct privileges

404Geofence ID not found

413Payload Too Large The request size exceeds the maximum size limit for payloads.