Update location​

PATCH
/locations/{locationId}

Partially updates a location. Omit fields to leave them unchanged; nullable fields such as location, metadata, price, and electricityCost can be set to null to clear them.

Use cases

  • Correct a site name, timezone, or address.
  • Change its tariff, electricity costs, or public and roaming settings.

Related endpoints

  • GET /locations/{locationId} — read the current configuration.
  • GET /locations/{locationId}/images — manage the location gallery.

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Path Parameters

locationId*

ID returned by POST /locations or GET /locations. It scopes location updates and image operations to one site.

Type
string
Required
Example"2ABCDEFGHJKLMNPQRSTU"
Min Length
1
Max Length
40

Request Body​

application/json
Min Length1
Max Length40

IANA timezone used to interpret tariff dates and local-time restrictions.

Default"Etc/UTC"

Responses​

success.location.update

application/json

Playground​

Authorization
Headers
Variables
Key
Value
Body

Samples​