Public API – POST Update Zone

The Zones endpoint allows existing Zones to be amended. Each Zone may contain one or many geofences, actions and conditions. Zone Id of the existing Zone must be provided for a successful update. If the Zone Id is not provided a new Zone will be created.

URL to call

Content Type

The content type should be specified in the Content-Type HTTP header as “application/json”.

Content-Type: application/json

Parameters

No URL Parameters required. See example JSON below.

Key JSON fields

Name

Required

Data Type

Description

Format

customerApiKey

String

API key for customer (rather than the app)

apiKey

String

API Key of the relevant app

zoneName

String

Name given to the Zone

zoneId

String

The identifier of the Zone being updated

HHH:MM

minimumRetriggerTime

String

Minimum retrigger time (MRT) is the amount of time that needs to expire before the Zone retriggers actions for the same user. If Checkout is not enabled, the MRT starts after a user checks in at the Zone. For example, if you enter 10:00, actions will only retrigger when the user checks in at the same Zone after 10 hours. If Checkout is enabled, the MRT activates only after a checkout event has happened.

HH:MM

timeActive

Object

Outside this time range, actions will not trigger when a user enters a Zone; allowing for significant battery saving. Time must use a 12 hour clock, with the period supplied as “am” or “pm”.

true/false

activeAllDay

Boolean

Active All Day option will keep the Zone active throughout the day. (Either activeAllDay or timeActive field needs to be provided in the request JSON. They cannot be used together.)

true/false

enableCheckOut

Boolean

Marks Zone as a checkout Zone. When a device exits a fence or the range of a beacon, a custom action will be triggered. In a checkout Zone, Minimum Retrigger Time applies only after a device checks out of a fence or beacon.

Checkout is not applicable for GEOLINE™ components. The checkout feature is only available in SDK version 1.6 and above.