HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Charge Point / Update

patch
https://{tenantUrl}/public-api/resources/charge-points/v2.0/

Update a charge point

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Query Params
include
array of strings
include
Allowed:
Body Params
string
length ≤ 255
string
enum

public - a charge point visible on the map to everybody

private - by default hidden from the map and for private usage only - company and their employees for example. The visibility of the charge point could be managed in partner object, with the different options for accessType.

personal - the charge point could have a single owner only. The owner is set when the user claims the charger or with Actions / Change Owner.

Allowed:
string | null

Required if accessType is personal. The PIN should be provided in the mobile app when the charge point is claimed by a user. Should contain only numbers.

integer | null

Required if accessType is public or private. NOT required if accessType is personal.

integer | null
integer | null

If there is Electricity rate set to the Charge point the electricity cost for each charging session would be tracked. Dynamic electricity rates could not be selected, only ones created in the resource / electricity-rate.

integer | null

The ID of the third-party electricity cost reimbursement integration to use for processing reimbursements for charging sessions at this charge point. Only applicable to personal (home) charge points - ignored for public and private charge points.

integer | null

The ID of the Installation & Maintenance company associated with this charge point. Must be owned by the same operator.

Validation:

  • If provided and not null, must reference a valid I&M company ID that belongs to the operator
  • Invalid or cross-operator I&M company IDs return validation error: "The selected installation and maintenance company ID is invalid"
  • Can be set to null to remove I&M company assignment
string | null

Country-specific station identifier for NAP reporting (e.g., BNetzA Stations-ID for Germany).

string | null
enum

Calibration law data availability override for Hubject/OICP compliance. Set to local if the charger has a certified on-site display for signed meter readings. Set to not_available for chargers whose hardware is not calibration-law compliant (e.g. cannot produce signed meter values). Set to null to use automatic resolution (External when Eichrecht is supported, Not Available otherwise).

Allowed:
subscription
object

An active subscription could be required for personal (home) charge points in order to use the charge point.

string
enum
Allowed:
string
enum

Shows the system status of the Charge Point.

  • enabled - the charge point is fully operative.
  • disabled - the charge point would not be shown on the map if it is a commercial public or commercial private with the relevant option for visibility nor could be claimed or found by ID if it is personal (home).
  • demo - acts as a simulator so different setups could be tested.
  • out of order - the charge point is visible and shared with users, but a charging session
Allowed:
boolean
Defaults to true
deprecated

This flag indicates whether the operator can actively manage the charge point. If the flag is set to false the charge point can still be shown to users, but they can't request to start a session on it.

Deprecated. Please use communicationMode instead. The communicationMode can only be set when creating a charge point.

string | null
network
object
capabilities
array of strings

remote_start_stop_capable - whether Remote start/stop is possible for the Charge Point

meter_values - whether the Charge Point should send meter updates to the system

stop_transaction_on_ev_disconnect - for ongoing sessions, when the cable is unplugged this should stop the session and if it is returned back a new session would be created.

disregard_the_heartbeats - only for OCPP 1.5 SOAP. Network status by default is updated based on the heartbeat messages. When enabled, the Charge Point would be always treated as available and its network status would not depend on heartbeat messages.

display_messages - charger has a display and it is enabled to display messages. This capability is enabled automatically when the charger reports the corresponding configuration key. When creating a charge point, the capability is ignored as it is automatically detected on boot.

capabilities
Allowed:
boolean
Defaults to false

When enabled the system would allow charging sessions initiated

locally by the charge point assuming it is setup to work in auto-start /

plug-and-charge mode. It would also automatically start a

session with a remote start command if one is not already started by the charging stations a

few seconds after a Preparing status is detected indicating that a vehicle is connected.

boolean
Defaults to false

The Auto-start option above does 2 things: (1) it allows charging

sessions started by the charge point assuming that it may be set up locally

to auto-start charging when a vehicle is connected and (2) if the charging

station doesnt start the session within a few seconds after the vehicles is

connected the system sends a remote start command - which is to emulate auto-start

charging. With this checkbox you can disable the emulation and rely

entirely on the charging station to auto-start the charging.

security
object
integer | null

The ID of the CP Model, if one is associated with the Charge Point. Can be set to null to remove the current CP Model associated with the Charge Point. Mind that on boot the charger reports the hardware model and it is automatically updated.

boolean
Defaults to true

When enabled, issues are created for hardware faults and connectivity problems, and notifications/webhooks are sent. When disabled, no issues are created and no notifications are sent for this charge point.

boolean
Defaults to true

When enabled, the system automatically attempts to recover the charge point when hardware faults are detected (status requests, soft reboots). When disabled, issues are still created (if monitoring is enabled) but no automated recovery actions are taken.

boolean
Defaults to false
deprecated

DEPRECATED: This field will be removed in v2.1 (target: Q2 2026). Use monitoringEnabled and autoRecoveryEnabled instead.

Previous Behavior (Single Toggle):
This field previously controlled both monitoring/notifications AND auto-recovery with a single toggle. Setting it to true enabled both behaviors, while false disabled both. This forced an "all-or-nothing" approach.

New Behavior (Independent Controls):
The new fields provide independent control:

  • monitoringEnabled - Controls issue creation and notifications
  • autoRecoveryEnabled - Controls automated recovery attempts

Current Backward Compatibility:
When provided in a request, this field sets BOTH monitoringEnabled AND autoRecoveryEnabled to the same value for backward compatibility.

Migration Guide - Common Use Cases:

  1. Receive notifications only (no auto-recovery):

    • Set monitoringEnabled: true, autoRecoveryEnabled: false
    • Use case: Manual control over recovery, but still get alerts

  2. Auto-recovery only (silent mode):

    • Set monitoringEnabled: false, autoRecoveryEnabled: true
    • Use case: Auto-fix issues without creating alerts (not recommended - no visibility)

  3. Full automation (current default):

    • Set monitoringEnabled: true, autoRecoveryEnabled: true
    • Old equivalent: enableAutoFaultRecovery: true

  4. Disabled (manual control):

    • Set monitoringEnabled: false, autoRecoveryEnabled: false
    • Old equivalent: enableAutoFaultRecovery: false

Migration Deadline: Please migrate to the new fields by Q1 2026.

user
object

Owner information along with owner preferences of the charge point when of type personal. If smart charging is enabled, smart charging preferences are also included.

partner
object
integer | null
tags
array of strings

Tags can be used for filtering and grouping chargers by tag. When doing a PATCH input all tags that should be associated with the charge point. Omitting a tag would remove it from the charge point.

tags
boolean

Controls Uptime tracking for the charge point. When set to true, enables Uptime tracking by creating an operational period. When set to false, disables Uptime tracking. When omitted, the current value is preserved. Only applicable to commercial charge points (public or private) on operators with operational availability enabled.

Validation:

  • Returns HTTP 422 with "Uptime tracking can only be enabled for commercial charge points" when the charge point is personal type
  • Returns HTTP 422 with "Operator must have operational availability enabled to track uptime" when the operator has operational availability disabled
boolean

Applicable for personal charge points and private charge points with Time of Day schedule. For public charge points will be omitted.

integer | null

If both noticeId and partner.notice object are provided in the request the noticeId will be used to complete the request NOT the partner.notice object!

boolean
Defaults to false

When enabled, if no electricity rate is assigned to the charge point any roaming session will be marked as using renewable energy.
The actual energy mix can be specified in an electricity rate, which can then be assigned to the charge point. In that case the energy mix will be provided for roaming sessions.
This information can be gathered from the utility provider or third-party platforms that provide this information to the public.

date-time | null

ISO 8601 formatted date

date-time | null

ISO 8601 formatted date

tariffDisplayMessages
object

Per-message settings for tariff and cost display. Only applicable when the charge point supports tariff and cost display (displayTariffAndCosts is true).
All fields are optional. On create, omitted fields default to true. On update, omitted fields retain their current value.

publicSharing
object

Public access controls for a personal charge point. Only applicable to personal charge points and requires the home-charging-reimbursement feature.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?