Update charging session​

PATCH
/sessions/{chargingSessionId}

Updates the session note. This endpoint does not change the session state or its meter readings.

Use cases

  • Attach an operator note or support context to a session.

Related endpoints

  • GET /sessions/{chargingSessionId} — read the session and its current note.
  • GET /sessions — find the session by its searchable fields.

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Path Parameters

chargingSessionId*

ID returned by POST /sessions/start or GET /sessions. Use it to retrieve meter readings or stop that session.

Type
string
Required
Example"3ABCDEFGHJKLMNPQRSTU"
Min Length
1
Max Length
40

Request Body​

application/json

Operator note to save, or null to clear the existing note.

Responses​

success.chargingSession.update

application/json

Playground​

Authorization
Headers
Variables
Key
Value
Body

Samples​