ChargePoints / Update

PUT

api

assets

chargepoints

{uuid}

ChargePoints / Update

curl --request PUT \
  --url https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "evse_id": "DE*CHC*E0001*0001",
  "connector_id": "1",
  "export": true,
  "phase": "ac",
  "position": "left connector",
  "parking_space_numbers": "<string>",
  "reserved_parking": 1,
  "access": "fleet",
  "user": "<string>",
  "name": "<string>",
  "sms_id": 123,
  "reservable": false,
  "remote_stop_capable": false,
  "in_roaming": false,
  "access_types": [
    {}
  ],
  "adhoc_sticker": false,
  "serial_number": 123,
  "article_number": 123,
  "parking_restrictions": "<string>",
  "unlock_capable": false,
  "public_comment": "<string>"
}
'

import requests

url = "https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}"

payload = {
    "evse_id": "DE*CHC*E0001*0001",
    "connector_id": "1",
    "export": True,
    "phase": "ac",
    "position": "left connector",
    "parking_space_numbers": "<string>",
    "reserved_parking": 1,
    "access": "fleet",
    "user": "<string>",
    "name": "<string>",
    "sms_id": 123,
    "reservable": False,
    "remote_stop_capable": False,
    "in_roaming": False,
    "access_types": [{}],
    "adhoc_sticker": False,
    "serial_number": 123,
    "article_number": 123,
    "parking_restrictions": "<string>",
    "unlock_capable": False,
    "public_comment": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    evse_id: 'DE*CHC*E0001*0001',
    connector_id: '1',
    export: true,
    phase: 'ac',
    position: 'left connector',
    parking_space_numbers: '<string>',
    reserved_parking: 1,
    access: 'fleet',
    user: '<string>',
    name: '<string>',
    sms_id: 123,
    reservable: false,
    remote_stop_capable: false,
    in_roaming: false,
    access_types: [{}],
    adhoc_sticker: false,
    serial_number: 123,
    article_number: 123,
    parking_restrictions: '<string>',
    unlock_capable: false,
    public_comment: '<string>'
  })
};

fetch('https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'evse_id' => 'DE*CHC*E0001*0001',
    'connector_id' => '1',
    'export' => true,
    'phase' => 'ac',
    'position' => 'left connector',
    'parking_space_numbers' => '<string>',
    'reserved_parking' => 1,
    'access' => 'fleet',
    'user' => '<string>',
    'name' => '<string>',
    'sms_id' => 123,
    'reservable' => false,
    'remote_stop_capable' => false,
    'in_roaming' => false,
    'access_types' => [
        [
                
        ]
    ],
    'adhoc_sticker' => false,
    'serial_number' => 123,
    'article_number' => 123,
    'parking_restrictions' => '<string>',
    'unlock_capable' => false,
    'public_comment' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}"

	payload := strings.NewReader("{\n  \"evse_id\": \"DE*CHC*E0001*0001\",\n  \"connector_id\": \"1\",\n  \"export\": true,\n  \"phase\": \"ac\",\n  \"position\": \"left connector\",\n  \"parking_space_numbers\": \"<string>\",\n  \"reserved_parking\": 1,\n  \"access\": \"fleet\",\n  \"user\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sms_id\": 123,\n  \"reservable\": false,\n  \"remote_stop_capable\": false,\n  \"in_roaming\": false,\n  \"access_types\": [\n    {}\n  ],\n  \"adhoc_sticker\": false,\n  \"serial_number\": 123,\n  \"article_number\": 123,\n  \"parking_restrictions\": \"<string>\",\n  \"unlock_capable\": false,\n  \"public_comment\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"evse_id\": \"DE*CHC*E0001*0001\",\n  \"connector_id\": \"1\",\n  \"export\": true,\n  \"phase\": \"ac\",\n  \"position\": \"left connector\",\n  \"parking_space_numbers\": \"<string>\",\n  \"reserved_parking\": 1,\n  \"access\": \"fleet\",\n  \"user\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sms_id\": 123,\n  \"reservable\": false,\n  \"remote_stop_capable\": false,\n  \"in_roaming\": false,\n  \"access_types\": [\n    {}\n  ],\n  \"adhoc_sticker\": false,\n  \"serial_number\": 123,\n  \"article_number\": 123,\n  \"parking_restrictions\": \"<string>\",\n  \"unlock_capable\": false,\n  \"public_comment\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"evse_id\": \"DE*CHC*E0001*0001\",\n  \"connector_id\": \"1\",\n  \"export\": true,\n  \"phase\": \"ac\",\n  \"position\": \"left connector\",\n  \"parking_space_numbers\": \"<string>\",\n  \"reserved_parking\": 1,\n  \"access\": \"fleet\",\n  \"user\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sms_id\": 123,\n  \"reservable\": false,\n  \"remote_stop_capable\": false,\n  \"in_roaming\": false,\n  \"access_types\": [\n    {}\n  ],\n  \"adhoc_sticker\": false,\n  \"serial_number\": 123,\n  \"article_number\": 123,\n  \"parking_restrictions\": \"<string>\",\n  \"unlock_capable\": false,\n  \"public_comment\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "chargepoint": {
    "uuid": "<string>",
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "modification_date": "2023-12-25",
    "location_uuid": "<string>",
    "controller_uuid": "<string>",
    "station_uuid": "<string>",
    "evse_id": "DE*CHC*E0001*0001",
    "connector_id": "1",
    "status_modified": "2023-12-25",
    "status": "Available",
    "evse": "<string>",
    "chargepoint_type": "internal",
    "export": true,
    "phase": "ac",
    "position": "left connector",
    "parking_space_numbers": "<string>",
    "reserved_parking": 1,
    "access": "fleet",
    "user": "<string>",
    "name": "<string>",
    "sms_id": 123,
    "reservable": false,
    "remote_stop_capable": false,
    "in_roaming": false,
    "access_types": [
      {
        "access_type": "rfid"
      }
    ],
    "adhoc_type": "free",
    "adhoc_sticker": false,
    "serial_number": 123,
    "article_number": 123,
    "parking_restrictions": "<string>",
    "unlock_capable": false,
    "public_comment": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "errors": [
    {
      "errorKey": "<string>",
      "message": "<string>",
      "parameter": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth2 Bearer Authorization

Scopes

asset:chargepoints

Headers

Accept-Language

string

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

Example:

"en"

Path Parameters

uuid

string

required

UUID of the ChargePoint

Pattern: ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$

Body

application/json

Updates a chargepoint. Required permission: asset:chargepoints:update. Available contexts: API Key, User.

evse_id

string

required

Globally unique EVSE-ID following the format defined by the BDEW and exposed to roaming partners. Each EVSE-ID can only be assigned once.

Maximum string length: 100

Example:

"DE*CHC*E0001*0001"

connector_id

integer<int32>

required

OCPP connector ID identifying the connector in OCPP messages between the controller and the backend.

Required range: x >= 0

Example:

"1"

export

boolean

default:true

Controls whether this charging point is included in interface outputs such as the Whitelabel app and POI data. Set to false to hide it from all public-facing outputs. Defaults to true.

phase

enum<string>

Electrical phase type. Must match the hardware configuration and is used for power calculation, app display, and transmission to roaming partners. Allowed values: ac (alternating current), dc (direct current).

Available options:

ac,

dc

Example:

"ac"

position

string

Free-text physical position on site, e.g. "left wall, slot 3".

Maximum string length: 255

Example:

"left connector"

parking_space_numbers

string

Assigned parking space number(s), comma-separated for multiple values. Sequential numbering is recommended when multiple stations share a location and is required for Hectronic payment terminal integrations.

Maximum string length: 20

reserved_parking

integer<int64>

Number of parking spaces at this charging point that are reserved. A value of 0 means no spaces are reserved.

Required range: x >= 0

access

enum<string>

Who may use the charging point. Public charging points must be reported to national access points as required by AFIR. Allowed values: private, public, parapublic (e.g. retail parking during opening hours), carsharing, employee, homecharger, fleet.

Available options:

private,

public,

parapublic,

carsharing,

employee,

homecharger,

fleet

Example:

"fleet"

user

string

Optional free-text label for the intended user group or operator responsible for this charging point (e.g. for home chargers).

Maximum string length: 100

name

string

Optional display name for identifying the charging point in the backend. Does not need to be unique.

Maximum string length: 100

sms_id

integer<int32>

Optional ID for SMS-based charging session initiation. Required only when the charging point supports SMS as an access method.

reservable

boolean

default:false

Whether the charging point can be reserved in advance via the app. Requires the station to support the OCPP reservation feature. Defaults to false.

remote_stop_capable

boolean

default:false

Whether a charging session can be stopped remotely via the app or direct payment interface. Must be explicitly enabled per charging point. Defaults to false.

in_roaming

boolean

default:false

Whether the charging point is enabled for roaming, making it accessible to drivers using third-party EMP apps via platforms such as Hubject, OCPI, or OCHP. The access type and roaming settings together determine visibility in roaming networks. Defaults to false.

access_types

object[]

The access types that can be used to authorize a charging session at this charge point (rfid, sms, key, free, app, other). SMS is only available with the SMS module.

Show child attributes

adhoc_type

enum<string>

How ad-hoc charging is offered. Allowed values: none (not offered), standard (paid), free.

Available options:

free,

none,

standard

adhoc_sticker

boolean

default:false

Whether a physical ad-hoc payment sticker (QR / NFC) has been applied. Mandatory for publicly accessible charging points and must be ordered separately. Defaults to false.

serial_number

integer<int32>

Hardware serial number from the manufacturer.

article_number

integer<int32>

Manufacturer SKU identifying the model.

parking_restrictions

string

Free-text parking restrictions (e.g. customers only, max duration). Transmitted to roaming partners and displayed in the app where supported.

Maximum string length: 100

unlock_capable

boolean

default:false

Whether the connector can be unlocked remotely via the backend, for example when a cable becomes stuck. Defaults to false.

public_comment

string

Public-facing comment displayed in the Whitelabel app and transmitted via web services (POI data). Use it for information relevant to end users, such as access instructions or local restrictions.

Maximum string length: 255

Response

The updated charging point in full projection.

chargepoint

object

required

The charge point record with its EVSE ID, status, access settings and station assignment.

Show child attributes

⌘I

ChargePoints / Update

curl --request PUT \
  --url https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "evse_id": "DE*CHC*E0001*0001",
  "connector_id": "1",
  "export": true,
  "phase": "ac",
  "position": "left connector",
  "parking_space_numbers": "<string>",
  "reserved_parking": 1,
  "access": "fleet",
  "user": "<string>",
  "name": "<string>",
  "sms_id": 123,
  "reservable": false,
  "remote_stop_capable": false,
  "in_roaming": false,
  "access_types": [
    {}
  ],
  "adhoc_sticker": false,
  "serial_number": 123,
  "article_number": 123,
  "parking_restrictions": "<string>",
  "unlock_capable": false,
  "public_comment": "<string>"
}
'

import requests

url = "https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}"

payload = {
    "evse_id": "DE*CHC*E0001*0001",
    "connector_id": "1",
    "export": True,
    "phase": "ac",
    "position": "left connector",
    "parking_space_numbers": "<string>",
    "reserved_parking": 1,
    "access": "fleet",
    "user": "<string>",
    "name": "<string>",
    "sms_id": 123,
    "reservable": False,
    "remote_stop_capable": False,
    "in_roaming": False,
    "access_types": [{}],
    "adhoc_sticker": False,
    "serial_number": 123,
    "article_number": 123,
    "parking_restrictions": "<string>",
    "unlock_capable": False,
    "public_comment": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    evse_id: 'DE*CHC*E0001*0001',
    connector_id: '1',
    export: true,
    phase: 'ac',
    position: 'left connector',
    parking_space_numbers: '<string>',
    reserved_parking: 1,
    access: 'fleet',
    user: '<string>',
    name: '<string>',
    sms_id: 123,
    reservable: false,
    remote_stop_capable: false,
    in_roaming: false,
    access_types: [{}],
    adhoc_sticker: false,
    serial_number: 123,
    article_number: 123,
    parking_restrictions: '<string>',
    unlock_capable: false,
    public_comment: '<string>'
  })
};

fetch('https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'evse_id' => 'DE*CHC*E0001*0001',
    'connector_id' => '1',
    'export' => true,
    'phase' => 'ac',
    'position' => 'left connector',
    'parking_space_numbers' => '<string>',
    'reserved_parking' => 1,
    'access' => 'fleet',
    'user' => '<string>',
    'name' => '<string>',
    'sms_id' => 123,
    'reservable' => false,
    'remote_stop_capable' => false,
    'in_roaming' => false,
    'access_types' => [
        [
                
        ]
    ],
    'adhoc_sticker' => false,
    'serial_number' => 123,
    'article_number' => 123,
    'parking_restrictions' => '<string>',
    'unlock_capable' => false,
    'public_comment' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}"

	payload := strings.NewReader("{\n  \"evse_id\": \"DE*CHC*E0001*0001\",\n  \"connector_id\": \"1\",\n  \"export\": true,\n  \"phase\": \"ac\",\n  \"position\": \"left connector\",\n  \"parking_space_numbers\": \"<string>\",\n  \"reserved_parking\": 1,\n  \"access\": \"fleet\",\n  \"user\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sms_id\": 123,\n  \"reservable\": false,\n  \"remote_stop_capable\": false,\n  \"in_roaming\": false,\n  \"access_types\": [\n    {}\n  ],\n  \"adhoc_sticker\": false,\n  \"serial_number\": 123,\n  \"article_number\": 123,\n  \"parking_restrictions\": \"<string>\",\n  \"unlock_capable\": false,\n  \"public_comment\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"evse_id\": \"DE*CHC*E0001*0001\",\n  \"connector_id\": \"1\",\n  \"export\": true,\n  \"phase\": \"ac\",\n  \"position\": \"left connector\",\n  \"parking_space_numbers\": \"<string>\",\n  \"reserved_parking\": 1,\n  \"access\": \"fleet\",\n  \"user\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sms_id\": 123,\n  \"reservable\": false,\n  \"remote_stop_capable\": false,\n  \"in_roaming\": false,\n  \"access_types\": [\n    {}\n  ],\n  \"adhoc_sticker\": false,\n  \"serial_number\": 123,\n  \"article_number\": 123,\n  \"parking_restrictions\": \"<string>\",\n  \"unlock_capable\": false,\n  \"public_comment\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chargecloud.dev/api/v1/assets/chargepoints/{uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"evse_id\": \"DE*CHC*E0001*0001\",\n  \"connector_id\": \"1\",\n  \"export\": true,\n  \"phase\": \"ac\",\n  \"position\": \"left connector\",\n  \"parking_space_numbers\": \"<string>\",\n  \"reserved_parking\": 1,\n  \"access\": \"fleet\",\n  \"user\": \"<string>\",\n  \"name\": \"<string>\",\n  \"sms_id\": 123,\n  \"reservable\": false,\n  \"remote_stop_capable\": false,\n  \"in_roaming\": false,\n  \"access_types\": [\n    {}\n  ],\n  \"adhoc_sticker\": false,\n  \"serial_number\": 123,\n  \"article_number\": 123,\n  \"parking_restrictions\": \"<string>\",\n  \"unlock_capable\": false,\n  \"public_comment\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "chargepoint": {
    "uuid": "<string>",
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "modification_date": "2023-12-25",
    "location_uuid": "<string>",
    "controller_uuid": "<string>",
    "station_uuid": "<string>",
    "evse_id": "DE*CHC*E0001*0001",
    "connector_id": "1",
    "status_modified": "2023-12-25",
    "status": "Available",
    "evse": "<string>",
    "chargepoint_type": "internal",
    "export": true,
    "phase": "ac",
    "position": "left connector",
    "parking_space_numbers": "<string>",
    "reserved_parking": 1,
    "access": "fleet",
    "user": "<string>",
    "name": "<string>",
    "sms_id": 123,
    "reservable": false,
    "remote_stop_capable": false,
    "in_roaming": false,
    "access_types": [
      {
        "access_type": "rfid"
      }
    ],
    "adhoc_type": "free",
    "adhoc_sticker": false,
    "serial_number": 123,
    "article_number": 123,
    "parking_restrictions": "<string>",
    "unlock_capable": false,
    "public_comment": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "errors": [
    {
      "errorKey": "<string>",
      "message": "<string>",
      "parameter": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

Getting started - Core

Core API

Authorizations

Scopes

Headers

Path Parameters

Body

Response