MOmonta
Charge Auth Tokens

Patch an existing charge auth token

Changed on

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

patch/api/v1/charge-auth-tokens/{chargeAuthTokenId}

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/charge-auth-tokens/{chargeAuthTokenId}
  • Auth
    HTTP bearer

Path parameters

chargeAuthTokenIdinteger required

Request body

teamIdinteger nullable

Id of the team the charge auth token belongs to

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

namestring nullable

Name of the charge auth token

montaNetworkboolean nullable

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

roamingNetworkboolean nullable

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 is active, null means indefinitely. Note: Use ../block and ../unblock endpoints to (un)block a charge auth token.

partnerExternalIdstring nullable

External Id of this entity, managed by you.

partnerCustomPayloadobject nullable

Custom JSON payload for this entity, managed by you.</br>Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.

costCenterIdinteger nullable

Id of the cost center to assign to the charge auth token. Send null to clear the assignment; omit the field to leave it unchanged.

rollingSpendLimitnumber nullable

Maximum cumulative spend allowed on this charge auth token over a rolling 30-day window, as a plain decimal amount in the currency of rollingSpendLimit on read (currently always EUR). Omit the field to leave it unchanged. Must be strictly positive, and may not exceed the cap that applies to the owning operator — a request above the cap is rejected. Send null to remove the limit; this is only accepted when no cap applies, otherwise null is rejected and a value up to the cap is required.

dailyChargeCountLimitinteger nullable

Maximum number of charges this charge auth token may start in a rolling 24-hour window. Omit the field to leave it unchanged. Must be strictly positive, and may not exceed the cap that applies to the owning operator. Send null to remove the limit; this is only accepted when no cap applies, otherwise null is rejected and a value up to the cap is required.

concurrentChargesLimitinteger nullable

Maximum number of concurrent active charges this charge auth token may have. Omit the field to leave it unchanged. Must be strictly positive, and may not exceed the cap that applies to the owning operator. Send null to remove the limit; this is only accepted when no cap applies, otherwise null is rejected and a value up to the cap is required.

Example request

{
  "teamId": 42,
  "userId": 1,
  "vehicleId": 1,
  "name": "Monta Office Charge Key",
  "montaNetwork": true,
  "roamingNetwork": true,
  "operatorNetwork": true,
  "activeUntil": "2023-01-11T00:00:00Z",
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  },
  "costCenterId": 42,
  "rollingSpendLimit": 500,
  "dailyChargeCountLimit": 10,
  "concurrentChargesLimit": 2
}

Response

Charge auth token updated

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.</br>Note: the expected shape is a flat JSON object with named keys.

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

dailyChargeCountLimitinteger nullable

Maximum number of charges this charge auth token may start in a rolling 24-hour window. null means no limit is set.

concurrentChargesLimitinteger nullable

Maximum number of concurrent active charges this charge auth token may have. null means no limit is set.

Example response

{
  "id": 1,
  "identifier": "38C58DB85F4",
  "type": "vehicleId",
  "teamId": 13,
  "userId": 1,
  "vehicleId": 1,
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  },
  "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",
  "rollingSpendLimit": {
    "amount": 12312,
    "currency": {
      "id": 1,
      "master": true,
      "identifier": "DKK",
      "name": "Danish krone",
      "decimals": 2
    },
    "locale": "en"
  },
  "dailyChargeCountLimit": 10,
  "concurrentChargesLimit": 2
}

Changes

  • 0ca400461c52Revision changes
    • breaking

      the request property type changed from array to object

    • breaking

      the response's property type changed from array to object for status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status