Skip to main content
POST
Creates a location

Authorizations

Authorization
string
header
required

OAuth2 Bearer Authorization

Body

application/json

Creates a location. Required permission: asset:locations:create

name
string
required

The name of the location, displayed in the app and backend. Must be unique across all locations.

Maximum string length: 100
status
enum<string>
required

The current operational status of the location. Determines how the location is treated in the system and displayed to end users.

Available options:
in_questioning,
in_offer,
first_meeting,
in_planning,
under_construction,
active,
out_of_order,
no_activity,
discarded,
undefined
street
string
required

The street name of the location's physical address. Required for accurate geolocation and display on map services.

Maximum string length: 100
postal_code
string
required

The postal code of the location.

Maximum string length: 16
city
string
required

The city in which the location is situated.

Maximum string length: 100
country_code
enum<string>
required

The ISO 3166-1 alpha-3 country code of the location. Required for correct regional assignment and roaming data transmission.

Available options:
abw,
afg,
ago,
aia,
ala,
alb,
and,
are,
arg,
arm,
asm,
ata,
atf,
atg,
aus,
aut,
aze,
bdi,
bel,
ben,
bes,
bfa,
bgd,
bgr,
bhr,
bhs,
bih,
blm,
blr,
blz,
bmu,
bol,
bra,
brb,
brn,
btn,
bvt,
bwa,
caf,
can,
cck,
che,
chl,
chn,
civ,
cmr,
cod,
cog,
cok,
col,
com,
cpv,
cri,
cub,
cuw,
cxr,
cym,
cyp,
cze,
deu,
dji,
dma,
dnk,
dom,
dza,
ecu,
egy,
eri,
esh,
esp,
est,
eth,
fin,
fji,
flk,
fra,
fro,
fsm,
gab,
gbr,
geo,
ggy,
gha,
gib,
gin,
glp,
gmb,
gnb,
gnq,
grc,
grd,
grl,
gtm,
guf,
gum,
guy,
hkg,
hmd,
hnd,
hrv,
hti,
hun,
idn,
imn,
ind,
iot,
irl,
irn,
irq,
isl,
isr,
ita,
jam,
jey,
jor,
jpn,
kaz,
ken,
kgz,
khm,
kir,
kna,
kor,
kwt,
lao,
lbn,
lbr,
lby,
lca,
lie,
lka,
lso,
ltu,
lux,
lva,
mac,
maf,
mar,
mco,
mda,
mdg,
mdv,
mex,
mhl,
mkd,
mli,
mlt,
mmr,
mne,
mng,
mnp,
moz,
mrt,
msr,
mtq,
mus,
mwi,
mys,
myt,
nam,
ncl,
ner,
nfk,
nga,
nic,
niu,
nld,
nor,
npl,
nru,
nzl,
omn,
pak,
pan,
pcn,
per,
phl,
plw,
png,
pol,
pri,
prk,
prt,
pry,
pse,
pyf,
qat,
reu,
rou,
rus,
rwa,
sau,
sdn,
sen,
sgp,
sgs,
shn,
sjm,
slb,
sle,
slv,
smr,
som,
spm,
srb,
ssd,
stp,
sur,
svk,
svn,
swe,
swz,
sxm,
syc,
syr,
tca,
tcd,
tgo,
tha,
tjk,
tkl,
tkm,
tls,
ton,
tto,
tun,
tur,
tuv,
twn,
tza,
uga,
ukr,
umi,
ury,
usa,
uzb,
vat,
vct,
ven,
vgb,
vir,
vnm,
vut,
wlf,
wsm,
xkx,
yem,
zaf,
zmb,
zwe
Example:

"DEU"

latitude
number<float>
required

The precise geographic latitude of the location in decimal degrees. Used to display the location on maps and navigation services.

Example:

"50.946022"

longitude
number<float>
required

The precise geographic longitude of the location in decimal degrees. Together with latitude, this pins the location on all integrated map and POI services.

Example:

"6.942467"

operator
string
required

The name of the CPO (Charge Point Operator) responsible for this location. Used for display purposes and roaming data output.

Maximum string length: 100
Example:

"chargecloud GmbH"

operator_id
integer<int32>
required

The internal unique ID referencing the operator assigned to this location. Must correspond to a valid operator registered in the system.

Required range: x >= 0
support_hotline_country
enum<string>
required

The ISO 3166-1 alpha-3 country code for the support hotline number. Required to correctly format and display the hotline in the app and on roaming platforms like Hubject.

Available options:
abw,
afg,
ago,
aia,
ala,
alb,
and,
are,
arg,
arm,
asm,
ata,
atf,
atg,
aus,
aut,
aze,
bdi,
bel,
ben,
bes,
bfa,
bgd,
bgr,
bhr,
bhs,
bih,
blm,
blr,
blz,
bmu,
bol,
bra,
brb,
brn,
btn,
bvt,
bwa,
caf,
can,
cck,
che,
chl,
chn,
civ,
cmr,
cod,
cog,
cok,
col,
com,
cpv,
cri,
cub,
cuw,
cxr,
cym,
cyp,
cze,
deu,
dji,
dma,
dnk,
dom,
dza,
ecu,
egy,
eri,
esh,
esp,
est,
eth,
fin,
fji,
flk,
fra,
fro,
fsm,
gab,
gbr,
geo,
ggy,
gha,
gib,
gin,
glp,
gmb,
gnb,
gnq,
grc,
grd,
grl,
gtm,
guf,
gum,
guy,
hkg,
hmd,
hnd,
hrv,
hti,
hun,
idn,
imn,
ind,
iot,
irl,
irn,
irq,
isl,
isr,
ita,
jam,
jey,
jor,
jpn,
kaz,
ken,
kgz,
khm,
kir,
kna,
kor,
kwt,
lao,
lbn,
lbr,
lby,
lca,
lie,
lka,
lso,
ltu,
lux,
lva,
mac,
maf,
mar,
mco,
mda,
mdg,
mdv,
mex,
mhl,
mkd,
mli,
mlt,
mmr,
mne,
mng,
mnp,
moz,
mrt,
msr,
mtq,
mus,
mwi,
mys,
myt,
nam,
ncl,
ner,
nfk,
nga,
nic,
niu,
nld,
nor,
npl,
nru,
nzl,
omn,
pak,
pan,
pcn,
per,
phl,
plw,
png,
pol,
pri,
prk,
prt,
pry,
pse,
pyf,
qat,
reu,
rou,
rus,
rwa,
sau,
sdn,
sen,
sgp,
sgs,
shn,
sjm,
slb,
sle,
slv,
smr,
som,
spm,
srb,
ssd,
stp,
sur,
svk,
svn,
swe,
swz,
sxm,
syc,
syr,
tca,
tcd,
tgo,
tha,
tjk,
tkl,
tkm,
tls,
ton,
tto,
tun,
tur,
tuv,
twn,
tza,
uga,
ukr,
umi,
ury,
usa,
uzb,
vat,
vct,
ven,
vgb,
vir,
vnm,
vut,
wlf,
wsm,
xkx,
yem,
zaf,
zmb,
zwe
Example:

"DEU"

support_hotline
string
required

The phone number of the support or fault hotline for this location. Published in the Whitelabel app and transmitted to roaming partners.

Maximum string length: 25
Example:

"1234567890"

publish
boolean
default:true

Controls whether the location is publicly visible via interfaces and map services. Set to false to hide the location and all its associated charge points from public-facing outputs.

identifier
string

An optional short code (up to 5 alphanumeric characters) used to quickly identify the location internally.

Maximum string length: 5
Pattern: ^[A-z0-9]{0,5}$
Example:

"BUS02"

house_number
string

The house number associated with the location's street address. Only uppercase letters A–Z, digits, and spaces are permitted.

Maximum string length: 10
district
string

An optional sub-city area or neighborhood for more precise location description.

Maximum string length: 100
rural_district
string

An optional administrative district the location belongs to.

Maximum string length: 100
height
number<float>

The elevation of the location above sea level, in meters. Optional field used for internal technical documentation.

Required range: x >= 0
Example:

"100.00"

directions
string

Free-text navigation instructions to help drivers find the location. Displayed in the app to assist users arriving at the location.

Maximum string length: 500
description
string

An internal description of the location for backend users. Not displayed publicly.

Maximum string length: 500
website
string

An optional URL associated with the location, e.g. the site operator's webpage.

Maximum string length: 200
Example:

"https://www.google.com"

comment
string

A public-facing comment about the location, visible in the Whitelabel app and via POI web services. Use this for relevant information end users should see (e.g. access restrictions, parking notes).

Maximum string length: 500
partner
string

Links the location to a non-commodity partner agreement. When set, the location partner can view this location via the partner app and may receive revenue-share credits.

Maximum string length: 255
accounter
string

References the internal accounting entity associated with this location. Optional field used for financial allocation and reporting.

Maximum string length: 64
comment_usage_agreement
string

An optional note or reference related to usage agreement terms at this location.

Maximum string length: 500
level_measurement
string

Internal technical note regarding on-site level measurement. Used for grid connection documentation.

Maximum string length: 200
network_carrier
string

The mobile network carrier available at or used by the location. Optional field for technical infrastructure documentation.

Maximum string length: 255
available_power
string

The total electrical power available at the location's grid connection point.

Maximum string length: 100
additional_conditions
string

Any additional on-site connection or access conditions relevant for technicians or operators.

Maximum string length: 500
contract_id
integer<int32>

The ID of a linked location partner contract. Used to associate the location with a specific non-commodity agreement for automated revenue sharing.

Required range: x >= 0
facility_types
object[]

A list of facility types describing the surrounding environment of the location (e.g. supermarket, hotel, parking). Transmitted to national access points for public charge points as required by AFIR regulation.

Response

Location created

location
object
required

Location