NEnextbillion-ai
Geofence

Update a Geofence

Changed on
put/geofence/{id}

Request

Path parameters

idstring required

ID of the geofence to be updated. This is the ID that was generated/provided at the time of creating the geofence.

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

type'circle' | 'polygon' | 'isochrone'

Use this parameter to update the type of a geofence. Please note that you will need to provide required details for creating a geofence of the new type. Check other parameters of this method to know more.

namestring

Use this parameter to update the name of a geofence. Users can assign meaningful custom names to their geofences.

tagsstring[]

Use this parameter to add/modify one or multiple tags of a geofence. tags can be used to search or filter geofences (using Get Geofence List method).

Valid values for updating tags consist of alphanumeric characters (A-Z, a-z, 0-9) along with the underscore ('_') and hyphen ('-') symbols.

meta_dataobject

Updated the meta_data associated with a geofence. Use this field to define custom attributes that provide more context and information about the geofence being updated like country, group ID etc.

The data being added should be in valid JSON object format (i.e. key and value pairs). Max size allowed for the object is 65kb.

Example request

{
  "type": "\"type\":\"circle\"",
  "name": "\"name\":\"Los Angeles Downtown\"",
  "tags": [
    "\"tags\":[\"tags_1\", \"O69Am2Y4KL8q5Y5JuD-Fy-tdtEpkTRQo_ZYIK7\"]"
  ],
  "isochrone": {
    "coordinates": "\"coordinates\": \"13.25805884388484,77.91083661048299\"",
    "mode": "“mode”:”car”"
  }
}

Response

OK

messagestring

Displays the error message in case of a failed request. If the request is successful, this field is not present in the response.

statusstring

A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the API Error Codes section below for more information.

Changes

  • 7ee76f0ff679Revision changes
    • breaking

      removed the enum value circle of the request property

    • breaking

      removed the enum value isochrone of the request property

    • breaking

      removed the enum value polygon of the request property

    • info

      added the new circle enum value to the request property

    • info

      added the new isochrone enum value to the request property

    • info

      added the new polygon enum value to the request property

  • a800b73f11c1Revision changes
    • breaking

      removed the enum value circle of the request property

    • breaking

      removed the enum value isochrone of the request property

    • breaking

      removed the enum value polygon of the request property

    • info

      added the new circle enum value to the request property

    • info

      added the new isochrone enum value to the request property

    • info

      added the new polygon enum value to the request property