These docs are for v1.0. Click to read the latest docs for v3-prod.

Update Location

Use this endpoint to Update a business location object. A valid business location id is required. The optional removeRegion query parameter can be used to remove the region relationship from the location.

If the settings element is populated the scope will be set to the business location with the settings supplied. If your settings are uniform across all locations, then do not supply the settings element and the location will use the settings defined on the primary business location (company scoped). Company scoped settings cascade down to the locations. You can override any location that needs different settings by providing settings in the update model. Use the PUT /setup/v1/locations/{id}/settings/scope/{settingsScope} endpoint to change the settings scope only. This is typically used when switching from business location scope back to company.

Refer to: POST ​/setup​/v1​/locations endpoint for details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
boolean
Body Params
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
address
object
businessHours
object
settings
object
defaults
object
appointmentReminders
object
Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json