Creates a Region

post

https://api.edgeiq.io/api/v1/platform/regions

Create a geographic region

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

The database's unique id for this Region. Set by the system and unmodifiable

company_id

string

The id of the company to which this region belongs. If not set on creation, defaults to the creating user's company_id.

created_at

string

The server time at which the region was created in the API.

updated_at

string

The server time at which the region was updated in the API.

name

string

required

A descriptive name for the region, e.g. "Denver International Airport"

metadata

object

An object for storing user-defined metadata about the geographic region

geojson

object

required

A valid GeoJSON object (geojson.org) describing the geography of the region.

Must be of type 'Feature'
Must contain a 'geometry' property
The 'geometry' must be either of type 'Point' or 'Polygon'
All positions in geometry.coordinates (latitude, longitude pairs) are assumed to be in the WSG84 coordinate reference system
If the geometry is a polygon, the coordinates must contain exactly one linear ring, which must be a closed polygon of between 4 and 50 positions.
If the geometry is a point, the properties of the feature must contain a type property set to 'Circle', and a radius property which is the size of the circle in meters
The radius of point/radius regions must be a number or string that can be parsed to a number. The number must be greater than zero

Responses

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

201The newly created Region