Api-Key. Provide your API key as the value for the header
user_idswhich are generated at the time of creating a user. In the case of a user group, you may pass the group_id. If by default,
group_idsare not specified, then the geofence is activated for all the users of the project.
"user_ids"body parameter. Pass an array of
user_idsto create a geofence specific to multiple users.
"group_ids"body parameter. You may pass multiple group IDs into an array to create a geofence specific to those groups.
is_enabledfield in the body section.
"is_enabled"field is set to
metadatacan help identify and personalize the geofences while displaying them on a map. You can add this information while creating a geofence or updating a geofence.
tagcan help filter geofences easily. This field is optional. When a geofence event is generated, the
tagis also sent along with the event.
color_codedefines the color of the geofence and how it is displayed on the dashboard. Hex Code for CSS colors should be passed in this field without '
PUTAPI request along with the geofence endpoint.
end_dateas filters. If you pass a specific start date, make sure it is less than the current date since the end date will be set default to the current date. If you pass a specific
end_dateand leave the
start_dateempty, make sure it is greater than the current date.
geofence_idas a filter. If you pass a valid
geofence_id, the results will be filtered to the given geofence id.
geofence_idwhen you create a geofence using the Create Geofence API.
geofence_id, you can fetch the list of geofences that are tagged with the given
user_id, which was initially used during the Create Geofence API. The
user_idis created within the SDK during the
createUsermethod and returns a unique
user_idfor identification within the Roam environment.
user_idas a filter along with the date filter, the date filters will not be considered. And if you pass an empty or invalid
user_id, the API will return an error.
group_id, which was initially used during the Create Geofence API, you can pass the
group_idin the header parameter.
group_idwhen you create a group using the Create Group API.
group_idas a filter along with the date filter, the date filters will not be considered. Passing an empty or invalid
group_id, will return an error.
geofence_eventsflag must be set to
truefor the user. This can be done from the SDK using the
Roam.toggleEventsmethod or by updating the user using the API. If the
falsefor a user then geofence events are not processed for the location updates on the user. The user should also have
publishandsaveenabled in the SDK.