v1
latestOpenAPI 3.0.02026-08-061380344.2 KBCreate a Place
Create a place
Parameters
type REQUIRED
The type of place. Standard options are:
- Property Boundary
- Animal Enclosure
- Bed
- Buffer Zone
- Building
- Field
- Growing Enclosure
- Irrigation
- Other
Custom options are also allowed
title OPTIONAL
The name or title for this mapped place. Required if not linking to a grow location, bed or warehouse.
map_coords OPTIONAL
A JSON stringified array of polygon / coordinate objects, each including a lat and lng value.
For example:
"[{"lat":40.200893095255765,"lng":-105.17513049468994},{"lat":40.2006964261442,"lng":-105.17536652908325},{"lat":40.20045468624636,"lng":-105.17511976585388},{"lat":40.200606285944076,"lng":-105.17487300262451}]"
sqft OPTIONAL
A numeric value for the square feet of the area being mapped. This is used for calculating planting area if linked to a grow location or bed.
z_index OPTIONAL
A numeric value indicating the z-index or layer position of the mapped polygon.
color OPTIONAL
A hex value for the color of the polygon, including the #.
For example: '#000000' would be a black polygon.
If blank and specificity a standard place type a default color will be set.
plot_id OPTIONAL
The grow location id this place belongs to if, if applicable. Required if providing a bed id.
bed_id OPTIONAL
The bed id this place belongs to if, if applicable.
warehouse_id OPTIONAL
The warehouse id this place belongs to if, if applicable.
Headers
Request body
Example request
{
"color": "#000000",
"map_coords": "[{\"lat\":40.200893095255765,\"lng\":-105.17513049468994},{\"lat\":40.2006964261442,\"lng\":-105.17536652908325},{\"lat\":40.20045468624636,\"lng\":-105.17511976585388},{\"lat\":40.200606285944076,\"lng\":-105.17487300262451}]",
"sqft": 10968,
"title": "From API",
"type": "Animal Enclosure",
"z_index": 1
}Response
Successful response