HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Update a token

This endpoint allows you to update a token.

In EV charging systems, tokens (also known as ID tags or charge keys) are unique identifiers that authenticate users to initiate a charging session. Spirii differentiates between three different types of tokens:

  • RFIDs represent a physical identifier with a MiFare chip that can be read by chargers.
  • Virtual tokens represent a digital identifier for authentication through the Spirii app (or a branded app)
  • Vehicle tokens (also known as “Autocharge”) represent the vehicle's MAC address or VIN code that when registered in Spirii’s platform. They allow a charger to recognize a vehicle and authorize charging when a vehicle is plugged in.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required

Used to identify the token throughout the Spirii system

Body Params
date-time

Date and time from when the token can be used (ISO-8601 format). Defaults to current time if not provided.

date-time | null

Date and time when the token expires (ISO-8601 format).

boolean
Defaults to true

Indicates if the token is currently active.

boolean
Defaults to true

Indicates if roaming is enabled for this token.

boolean

Enables priority charging on the operator owned locations if set to true.

string | null

Reference used for billing purposes. This is a free field and can, for instance, be a billing reference on invoices or a cost centre reference. Leaving it empty, means it won't show on Spirii-generated billing documents.

string | null

Optional comment about the token.

identifier
object

Token identifier information. Only appUserId can be updated.

number

Unique identifier of the associated billing customer. Generally, the owner of the token and the entity that receives the monthly billing in case no credit card is attached to the token. Ensure the right customerId for the right entity to be billed.

Responses

400

Bad Request provided. A message will describe the issue.

403

Authorization header JWT token is invalid or not provided.

404

The provided token ID or customer ID was not found.

500

Internal Server Error.

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