Skip to main content

removeGeofences

Field Configurations

KeyTypeDescriptionDefault Value
"params" (required)Objectundefinednull

Parameters

KeyTypeDescriptionDefault Value
"async"BooleanSpecifies whether the action should perform asynchronously.null
"fences"ArrayFences to be removednull
"query"StringQuery to use.null
"queryParams"ArrayThe params to append to the query.null
"table"StringDatabase table to use.null
"template"StringTemplate to apply to the query result.null

Inherited

From Base Action

Base Action

Field Configurations

KeyTypeDescriptionDefault Value
"dynamicParams"ObjectDynamic params to retrieve data from a specific context e.g. a userSetting.null
"leadingDelimiter"StringThe leading mustache delimiter to use.null
"params"Object,ArrayObject containing the properties of the action.null
"trailingDelimiter"StringThe trailing mustache delimiter to use.null
"type"StringType name of the action.null

Examples

Example 1: remove fences by ID.

Remove geofences using static IDs.

{
"type": "removeGeofences",
"params": {
"fences": [
{
"id": "firstGeofence"
},
{
"id": "secondGeofence"
}
]
}
}

The actions to be executed are specified in the actions parameter, in this case a removeGeofences action.

Result:

A removeGeofences action has been created.

Example 2: remove fences using a query.

Remove geofences retrieving the IDs from a database.

{
"type": "removeGeofences",
"params": {
"table": "geofences",
"query": "activeFences"
}
}

The actions to be executed are specified in the actions parameter, in this case a removeGeofences action.

Result:

A removeGeofences action has been created.