[beta] Update a vendor location

Updates an existing maintenance vendor location. The linked Place owns the location's name, address, and notes; update them through the public Addresses API, not this resource. Use the location's addressId (or placeId.id from a mutation response) as {id} in GET /addresses/{id} to retrieve data.name, data.formattedAddress, and data.notes, and PATCH /addresses/{id} to update name, formattedAddress, and notes. These calls require Read Addresses and Write Addresses permissions, respectively. addressId is optional when the existing link identifies a live Place in this organization; otherwise supply a valid addressId before updating the location. Any supplied value must be the Address/Place ID returned as data.id by the Addresses API and identify a live Place in this organization. Legacy vendor-stored notes are separate and are not exposed or copied to the Place.

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

To use this endpoint, select Write Work Orders under the Work Orders 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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Include externalIds in the response. Defaults to false.

string
required

Unique identifier for the vendor location record.

Body Params

Request body for updating a vendor location

string

Linked place identifier for the vendor address.

assetAttributeSelections
array of objects

Assets this vendor can service. Empty replaces inherited selections; null clears the setting.

assetAttributeSelections
contacts
array of objects

People to contact at the vendor.

contacts
defaultLaborRatePerHour
object

VendorHourlyMoney object

emailAddresses
array of strings

Email addresses for the vendor.

emailAddresses
externalIds
array of objects

Customer-supplied external identifiers for the vendor, interchangeable with id in filters. Only included in the response when includeExternalIds is set.

externalIds
boolean

Whether this vendor provides mobile service. When unset, the profile or system default applies.

boolean

Whether this vendor location is preferred. When unset, the profile or system default applies.

string

Parent vendor UUID. Null removes membership while preserving explicit overrides.

string

Free-text AP/ERP payee identifier for the vendor. Not a reference to a Samsara entity.

phoneNumbers
array of strings

Phone numbers for the vendor.

phoneNumbers
string

Description of services provided by the vendor.

string
enum

Own lifecycle status. Defaults to active. Unknown is read-only. Valid values: active, inactive, unknown

Allowed:
string

User-defined identifier for the vendor.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json