[beta] Update a place

patch

https://api.samsara.com/places

Updates a place. Provide exactly one of query parameter placeId (Samsara id) or externalId (key:value). Only fields present in the JSON body are changed; omit a field to leave it unchanged.

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…

Query Params

placeId

int64

Samsara place id to update. Mutually exclusive with externalId; provide exactly one.

externalId

string

External id token in key:value form (e.g. crmId:warehouse-east). Mutually exclusive with placeId; provide exactly one.

Body Params

Partial update for a place.

address

string

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 switching to polygon mode.

geofence

hubLocations

object

Partial hub location changes for a place. When present on PATCH, applies upserts and removals; omitted leaves hub rows unchanged.

iftaExemptionTypes

array of strings

When present, replaces IFTA exemption types for the place.

iftaExemptionTypes

latitude

double

Center latitude when switching to or editing a circle geofence.

longitude

double

Center longitude when switching to or editing a circle geofence.

name

string

Place name.

navigation

object

Navigation metadata for create.

notes

string

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 IFTA metadata after this request; conflicting combinations return InvalidArgument.

placeTypes

radiusMeters

integer

≥ 1

Circle radius in meters; use with latitude and longitude.

safetyEventExclusions

array of strings

When present, replaces safety event exclusions for the place.

safetyEventExclusions

streetView

object

Street view settings for a place.

200OK 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.