Skip to navigation

Update a token

Only the fields sent change. ACTIVE and SUSPENDED tokens are pushed to partners again before the change is saved. If the push to roaming partners fails the call answers 502 and the token is left as it was; retry with the same Idempotency-Key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

token_idintegerRequired>=1

The token’s id.

Request

This endpoint expects an object.
visual_numberstring or nullOptional<=64 characters
contract_idstring or nullOptional1-36 characters
issuerstring or nullOptional1-64 characters
languagestring or nullOptionalformat: "^[a-z]{2}$"
whitelistenum or nullOptional
Allowed values:
group_idstring or nullOptional<=36 characters
metadatamap from strings to any or nullOptional

Response

The token after the update.
idinteger
organization_idstring
uidstring
typeenum or any
contract_idstring
issuerstring
country_codestring
party_idstring
whitelistenum or any
ocpi_versionstring
statusenum or any
created_atdatetime
last_updateddatetime
visual_numberstring or nullOptional
group_idstring or nullOptional
languagestring or nullOptional
valid_fromdatetime or nullOptional
valid_untildatetime or nullOptional
metadatamap from strings to any or nullOptional
status_reasonstring or nullOptional
invalidated_atdatetime or nullOptional

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error