API Reference

Edit a charging key

patch
https://{environment}.plugsurfing.com/drive/v1/users//charging-keys/

Modify a charging key's properties. You can change the key's name and enable/disable it. Disabling a key immediately prevents it from being used for charging. Important notes:

  • Only non-null fields in the request are applied
  • Disabling a key takes effect immediately across all charging stations
  • Some CPOs cache key status, so in rare cases it may take a few minutes for the disable action to propagate
  • Name changes are purely cosmetic and don't affect the key's functionality
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier for the charging key - can be either the keyId (internal identifier) or contractId (roaming identifier)

string
required

The unique identifier of the user who owns the charging key

Body Params

request

Request payload to update mutable charging key attributes.

string

Display name assigned to the charging key.

boolean

Changing to the value that the key already has will result in OK response.

string
enum

Defines whether the CPO may allow a session for this charging key when it cannot get a response from the EMP, or must always rely on realtime authorization from the EMP. Possible values: ALLOWED_OFFLINE, NEVER.

Allowed:
Responses

Updated 2 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago