Places

Creates a new Place

post/places

Request

Request body

OR

Example request

{
  "latitude": 33.515,
  "longitude": -86.80761,
  "polygon_coordinates_raw": "SRID=4326;POLYGON((-86.8 33.5, -86.7 33.5, -86.7 33.6, -86.8 33.6, -86.8 33.5))"
}

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

account_idinteger required
namestring required

A name for this Place.

addressstring nullable required

This Place's address.

address_componentsobject required
descriptionstring nullable required

A description of this Place.

place_visits_countinteger nullable required

The number of times this Place has been visited.

radius_in_metersinteger required

The radius around this Place's coordinates within which we consider this Place to have been visited.

latitudenumber float required

This Place's latitude.

longitudenumber float required

This Place's longitude.

is_sampleboolean required

Whether this Place is part of Sample Data.

locationstring required

The location of this Place.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "latitude": 33.515,
  "longitude": -86.80761
}

Changes

    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added subschema #1: With Circular Geofence subschema #2: With Polygon Geofence to the request body anyOf list