Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Charge Points Charging Rules

Create a charging rule for a charge point

Required scope: charge-points:write </br>Organization authorization: supported

post/api/v1/charge-points/{chargePointId}/charging-rules

Path parameters

chargePointIdinteger required

Request body

namestring required

Name of the charging rule

type'smart_charge' | 'scheduled' | 'instant' required

Types of Charge Point Charging Rules

isActiveboolean required

Indicates if this rule is active

isSponsoredboolean required

Indicates if the charge is sponsored

creatorUserIdinteger required

User ID of the rule creator that you ware impersonating

vehicleIdinteger nullable

Vehicle id of the vehicle this rule applies to

Example request

{
  "name": "Smart charging rule",
  "isActive": true,
  "isSponsored": true,
  "creatorUserId": 123,
  "vehicleId": 123,
  "settings": {
    "start": "22:00",
    "beReadyAt": "06:00",
    "defaultMaxBatteryPercentage": 80
  }
}

Response

Charging rule for charge point created

idinteger

Id of this charging rule

namestring required

Name of the charging rule

type'smart_charge' | 'scheduled' | 'instant' required

Types of Charge Point Charging Rules

isActiveboolean required

Indicates if this rule is active

isSponsoredboolean required

Indicates if the charge is sponsored

creatorUserIdinteger required

User that created this rule

vehicleIdinteger nullable

Vehicle id of the vehicle this rule applies to

supportedChargingRuleTypesChargingRuleType[] required

The type of charging rules supported by this charge point

Example response

{
  "id": 1,
  "name": "Smart charging rule",
  "isActive": true,
  "isSponsored": true,
  "creatorUserId": 123,
  "vehicleId": 123,
  "settings": {
    "start": "22:00",
    "beReadyAt": "06:00",
    "defaultMaxBatteryPercentage": 80
  }
}