v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Charge Auth Tokens

Create a new charge auth token

Required scope: charge-auth-tokens:write </br>Organization authorization: supported

post/api/v1/charge-auth-tokens

Request body

teamIdinteger required

Id of the team the charge auth token belongs

userIdinteger nullable

Id of the user the charge auth token should be associated to

vehicleIdinteger nullable

Id of the vehicle to link to this charge auth token

identifierstring required

Identifier of the the charge auth token, Note: without prefix e.g VID:

type'rfid' | 'vehicleId' required

namestring nullable

Name of the charge auth token

montaNetworkboolean

If the charge auth token should be active in the Monta network

roamingNetworkboolean

If the charge auth token should be active in the Roaming network

operatorNetworkboolean nullable

Indicates that the charge auth token can be used on other teams charge points underthe same operator

activeUntilstring date-time nullable

Indicates until when this charge auth token should be active, null means indefinitely

blockedAtstring date-time nullable

If the charge auth token is blocked, it will not be able to charge.

null = not blocked
date-time = blocked since date-time

partnerExternalIdstring nullable

External Id of this entity, managed by you.

partnerCustomPayloadobject[] nullable

Custom JSON payload for this entity, managed by you.

Example request

{
  "teamId": 42,
  "userId": 1,
  "vehicleId": 1,
  "identifier": "38C58DB85F4",
  "name": "Monta Office Charge Key",
  "montaNetwork": true,
  "roamingNetwork": true,
  "operatorNetwork": true,
  "activeUntil": "2023-01-11T00:00:00Z",
  "blockedAt": "2023-01-11T00:00:00Z",
  "partnerExternalId": "ACME-12345"
}

Response

Charge Auth Token Created

idinteger

The id of the charge auth token

identifierstring required

The identifier of the charge auth token, Note: without prefix e.g VID:

type'vehicleId' | 'rfid' required

The method type used for this charge auth token

teamIdinteger

Id of the team that the charge auth token belongs to

userIdinteger nullable

Id of the user that the charge auth token is associated to

vehicleIdinteger nullable

Id of the vehicle linked to this charge auth token

partnerExternalIdstring nullable

External Id of this entity, managed by you.

partnerCustomPayloadobject[] nullable

Custom JSON payload for this entity, managed by you.

namestring nullable

Name of the charge auth token

montaNetworkboolean

If the charge auth token is active in the Monta network

roamingNetworkboolean

If the charge auth token is active in the Roaming network

operatorNetworkboolean

Allow this charge auth token to be used on other teams charge points under the same operator

activeUntilstring date-time nullable

Indicates until when this charge auth token is active, null means indefinitely

blockedAtstring date-time nullable

If the charge auth token is blocked, it will not be able to charge.

null = not blocked
date-time = blocked since date-time

createdAtstring date-time required

Creation date of this charge auth token

updatedAtstring date-time required

Update date of this charge auth token

deletedboolean

If the charge auth token is deleted

Example response

{
  "id": 1,
  "identifier": "38C58DB85F4",
  "type": "vehicleId",
  "teamId": 13,
  "userId": 1,
  "vehicleId": 1,
  "partnerExternalId": "ACME-12345",
  "name": "Monta Team Key",
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "montaNetwork": true,
  "roamingNetwork": true,
  "operatorNetwork": true,
  "activeUntil": "2023-01-11T00:00:00Z",
  "blockedAt": "2023-01-11T00:00:00Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z"
}