Skip to main content

BulkCreateRequest

Request body for POST /api/v1/geofences/bulk.

dedup_strategy defaults to 'skip'. Endpoint enforces workspace.bulk_create_max_batch_size; informational cap here.

items object[]required
  • Array [
  • indexIndex (integer)required
    addressAddress (string)required

    Possible values: <= 500 characters

    name object
    anyOf
    string

    Possible values: <= 255 characters

    buffer_meters object
    anyOf
    integer

    Possible values: >= 1 and <= 10000

    tags object
    anyOf
  • Array [
  • string
  • ]
  • statusStatus (string)required

    Possible values: [ok, dedup, skipped, error]

    override_dedupOverride Dedup (boolean)
    Default value: false
    lat object

    Latitude of the geofence center. Send it with lng to place the geofence there without geocoding the address, for example the point a preview returned or a pin the user moved.

    anyOf
    number

    Possible values: >= -90 and <= 90

    lng object

    Longitude of the geofence center. Send it with lat.

    anyOf
    number

    Possible values: >= -180 and <= 180

    normalized_address object

    The geocoder's address label for lat/lng, as the preview returned it. Used to match duplicates; defaults to address.

    anyOf
    string

    Possible values: <= 500 characters

  • ]
  • dedup_strategyDedup Strategy (string)

    Possible values: [skip, override, fail]

    Default value: skip
    BulkCreateRequest
    {
    "items": [
    {
    "index": 0,
    "address": "string",
    "name": "string",
    "buffer_meters": 0,
    "tags": [
    "string"
    ],
    "status": "ok",
    "override_dedup": false,
    "lat": 0,
    "lng": 0,
    "normalized_address": "string"
    }
    ],
    "dedup_strategy": "skip"
    }