Update Location

This endpoint updates an existing location. Only the fields present in the request are changed (partial update).

Important Notes

  • times is a full replacement: send every open day. Any existing day not present in the request is removed.
  • online_booking enables or disables online booking for the location.
  • Use the activate and deactivate endpoints to change active.
  • An id that belongs to another company answers 404, the same as an unknown id.

Errors Dictionary

StatusErrorDetailDescription
400invalid_bodyexpected_objectRequest body is not a JSON object.
400invalid_address—Address must be a non-empty array with long_name and types keys.
400invalid_email—Email has an invalid format.
400invalid_coordinates—Latitude and longitude are validated as a pair and cannot be set to null.
400invalid_timezone—Timezone must be a valid IANA identifier.
400invalid_country_id—The country is not one of the company's enabled countries.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks locations:write scope.
404location_not_found—Location not found, or it belongs to another company.
422invalid_location_times—Opening hours have an invalid format, order, or duplicate days.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableconnection_failedThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Location unique identifier.

Body Params

Fields accepted when updating a location. Every field is optional; only the fields present in the request are changed. times replaces the whole schedule.

string
length ≤ 255

Location name.

address
array of objects

Google Maps address components.

address
string

Location email.

string

Location phone number.

integer

Country ID.

double
-90 to 90

Geographic latitude.

double
-180 to 180

Geographic longitude.

string

IANA timezone identifier.

boolean

Whether the location accepts online bookings.

times
array of objects

Full replacement of the opening hours. Days not sent are removed.

times
Responses

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