Updates an existing location.

patch

https://api.spirii.com/v2/locations/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

number

required

ID that Uniquely identifies the location

Body Params

name

string

Location name

address

string

Street address of the location

postalCode

string

Postal code

city

string

City name

countryCode

string

ISO-31661 alpha-2 country code of the CPO that 'owns' this location.

facilities

array of strings

List of available facilities at the location

facilities

coordinates

object

Geographical coordinates of the location

publish

boolean

Defines if a location may be published on websites & apps etc. This will be true for public locations

openingTimes

object

The times when the EVSEs at the location can be accessed for charging

ownerId

number

Legacy ID of the customer that 'owns' the location. An 'owner' represents a 'customer' in the Spirii Connect portal/UI. While the term 'ownerId' is outdated, this ID is retained for backward compatibility with legacy systems.

customerId

number

ID of the customer that 'owns' the location. The 'customerId' is the unique identifier for a customer. The 'customer' can be found in the Connect Customer management page. This customer ID corresponds with the customer ID that can be retrieved from the Customer v2 API.

tariffId

string

Uniquely identifies the tariff within the CPO’s platform

legacyTariffId

number

deprecated

The tariff displayed for all the users who are using older versions of the app

allowPriorityCharging

boolean

If a location allows priority charging

billingReference

string

An optional identifier used to reference specific charging sessions or transactions in invoices

parkingType

string

enum

Type of parking available.

The mapping of the parkingType to the Spirii location Type is visible in the table below:

[ParkingType] - [Spirii Location Type]

ON_STREET - Public road

ON_DRIVEWAY - Residential

PARKING_LOT - Parking lot

PARKING_GARAGE - Parking lot (indoor)

UNDERGROUND_GARAGE - Parking lot (underground)

OTHER - Hotel

Allowed:

Responses

400

Bad Request provided. A message will describe the issue.

403

Authorization header token is invalid or not provided.

500

Internal Server Error.

200