Skip to main content
POST
Locations / Create

Authorizations

Authorization
string
header
required

OAuth2 Bearer Authorization

Scopes

asset:locations

Headers

Accept-Language
string

BCP 47 language tag for content negotiation (e.g. en, de-DE).

Example:

"en"

Body

application/json

Creates a new location for the authenticated client. Required permission: asset:locations:create. Available contexts: API Key, User.

name
string
required

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

Maximum string length: 100
status
enum<string>
required

Lifecycle state. Allowed values: in_questioning (sales inquiry), first_meeting (initial customer meeting), in_offer (offer phase), in_planning (planning), under_construction (build in progress), active (live), out_of_order (offline), no_activity (idle), discarded (dropped), undefined.

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

Street name of the location address. Used for geolocation and display on map services.

Maximum string length: 100
postal_code
string
required

Postal / ZIP code.

Maximum string length: 16
city
string
required

City of the location address.

Maximum string length: 100
country_code
enum<string>
required

ISO 3166-1 alpha-3 country code (e.g. DEU, AUT, NLD).

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

WGS84 latitude in decimal degrees.

Example:

"50.946022"

longitude
number<float>
required

WGS84 longitude in decimal degrees.

Example:

"6.942467"

operator
string
required

Display name of the charging point operator (CPO).

Maximum string length: 100
Example:

"chargecloud GmbH"

support_hotline
string
required

The phone number of the support or fault hotline for this location, in international format (leading "+", digits only). Published in the Whitelabel app and transmitted to roaming partners.

Maximum string length: 25
Pattern: ^\+[0-9]{6,20}$
Example:

"+491234567890"

publish
boolean
default:true

Whether the location is publicly visible via interfaces and map services. When false, the location and all its charging points are hidden from public-facing outputs.

identifier
string

Short alphanumeric code the operator uses internally.

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

"BUS02"

house_number
string

House number of the location address, kept separate from street; may contain letters or suffixes (e.g., "12a").

Maximum string length: 10
district
string

City district / neighbourhood.

Maximum string length: 100
rural_district
string

Administrative rural district (Landkreis).

Maximum string length: 100
height
number<float>

Elevation above sea level in metres.

Required range: x >= 0
Example:

"100.00"

directions
string

Free-text driving / walking directions shown to drivers.

Maximum string length: 500
description
string

Internal free-text description of the location for backend users. Not displayed publicly.

Maximum string length: 500
website
string

Public website of the operator or the site.

Maximum string length: 200
Example:

"https://www.google.com"

comment
string

Public-facing comment about the location, visible in the Whitelabel app and via POI web services. Use it for 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 in the partner app and may receive revenue-share credits.

Maximum string length: 255
accounter
string

Name of the accounting party associated with this location. Used for financial allocation and reporting.

Maximum string length: 64
comment_usage_agreement
string

Free-text note about the usage agreement (Nutzungsvereinbarung).

Maximum string length: 500
level_measurement
string

Description of the on-site grid level measurement / metering setup.

Maximum string length: 200
network_carrier
string

Local distribution network operator (DNO / Netzbetreiber).

Maximum string length: 255
available_power
string

Grid power available on site (e.g. "63 A, 400 V").

Maximum string length: 100
additional_conditions
string

Additional contractual or operational conditions.

Maximum string length: 500
max_standing_time
string

Informational free-text describing the maximum allowed standing time at the location (e.g., "max. 4h between 8 a.m. and 6 p.m."). For driver/operator information only — not enforced by the system.

Maximum string length: 255
contract_id
integer<int32>

Identifies the non-commodity contract this location belongs to, used for automated revenue sharing. Must be owned by the same client.

Required range: x >= 0
facility_types
object[]

Facility types describing the surroundings of the location (e.g. "Hotel", "Restaurant", "Parking"). Transmitted to national access points for public charging points as required by AFIR regulation.

Response

The newly created location.

location
object
required

The location record with its address, coordinates, operator data and controllers.