[beta] Create a place

post

https://api.samsara.com/places

Creates a place. Supply either a polygon geofence (at least three vertices) or radiusMeters with latitude and longitude.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Places under the Places category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Fields for creating a place. Exactly one geometry mode is required: either (1) polygon geofence with at least three vertices, or (2) circle latitude, longitude, and radiusMeters (all three). Do not send both.

address

string

required

Single-line address string.

cameraRecordingModeType

string

enum

Camera recording mode: fullRecording, driverPrivacy, completePrivacy, or inherit. Valid values: fullRecording, driverPrivacy, completePrivacy, inherit, unknown, unspecified

Allowed:

geofence

array of objects

Polygon vertices; at least three when using polygon mode (omit entirely when using latitude, longitude, and radiusMeters for a circle).

geofence

hubLocations

array of objects

Initial route-planning hub rows for the new place. Each entry requires hubId. Omit hubLocationId to let the server assign a row UUID, or set hubLocationId to pin the UUID for idempotent creates.

hubLocations

iftaExemptionTypes

array of strings

IFTA exemption types for this place.

iftaExemptionTypes

isShowAddressesEnabled

boolean

When true, show addresses inside the geofence on the map.

latitude

double

Center latitude when using a circle geofence with radiusMeters.

longitude

double

Center longitude when using a circle geofence with radiusMeters.

name

string

required

Place name.

navigation

object

Navigation metadata for create.

notes

string

Optional notes.

placeTypes

array of strings

When present, replaces address-type categories via address metadata. Metadata-derived types (hubLocation, navigation, iftaExemption) must match hubLocations, navigation, and existing IFTA metadata in the same request; conflicting combinations return InvalidArgument.

placeTypes

radiusMeters

integer

≥ 1

Circle radius in meters; requires latitude and longitude. Must be at least 1 when set.

safetyEventExclusions

array of strings

Safety event types excluded at this place.

safetyEventExclusions

streetView

object

Street view settings for a place.

201Created response.

401Unauthorized response.

404Not Found response.

405Method Not Allowed response.

429Too Many Requests response.

500Internal Server Error response.

501Not Implemented response.

502Bad Gateway response.

503Service Unavailable response.

504Gateway Timeout response.

defaultBad Request response.