[beta] Create a place

post

https://api.samsara.com/places

Creates a place. Supply a polygon geofence, a circle geofence, or an auto geofence that resolves geometry server-side.

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. Required: name, address, and geofence with exactly one of circle, polygon, or auto populated.

address

string

required

Single-line address string.

businessContacts

object

Business contact information for a place.

cameraRecordingModeType

string

enum

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

Allowed:

geofence

object

required

Discriminated geofence on write. Exactly one of circle, polygon, or auto must be set.

iftaExemptionTypes

array of strings

IFTA exemption types for this place.

iftaExemptionTypes

isShowAddressesEnabled

boolean

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

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 routing, navigation, and existing IFTA metadata in the same request; conflicting combinations return InvalidArgument.

placeTypes

routing

array of objects

Initial route-planning rows for the new place. Each entry requires hubId; (placeId, hubId) must be unique.

routing

safetyEventExclusions

array of strings

Safety event types excluded at this place.

safetyEventExclusions

streetView

object

Street view settings on write.

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.