Skip to main content
POST
Start session

Authorizations

x-api-key
string
header
required

API key issued during onboarding. Every request must supply a valid x-api-key header.

Body

application/json
stationId
string
required

Public station identifier. Exactly 8 alphanumeric characters (a-zA-Z0-9).

Pattern: ^[a-zA-Z0-9]{8}$
chargerId
string
required

Public charger identifier within that station. Exactly 8 alphanumeric characters (a-zA-Z0-9).

Pattern: ^[a-zA-Z0-9]{8}$
connectorId
integer
required

Connector number on the charger to start the session on.

Required range: x >= 1
customerId
string
required

Customer identifier for the charging session. If no customer with this ID exists, a minimal customer is created.

Minimum string length: 1
auth_reference
string

Optional caller-generated unique reference. Must not be blank, and must not already belong to an existing session (409). If supplied, it can be used with GET /sessions?auth_reference=... to poll until the charger starts the session.

Minimum string length: 1

Response

Command accepted for delivery to the charger.

message
string
required

Human-readable status message. Treat this value as informational and do not depend on exact wording.