Update an existing integration

x-ms-visibility: "important"

Updates an existing integration based on the integration type.

Path Parameters

integrationId string required

Integration ID

application/json

Request Body required

Updated details for the integration

retryCredentialsExchange boolean
models object
pushCdr boolean nullable
pushSession boolean nullable
pushTariff boolean nullable
pushLocation boolean nullable
pullTokensAll boolean nullable
pullTariff boolean nullable
pullLocation boolean nullable
pullSession boolean nullable
pullCdr boolean nullable
pullVersionDetails boolean nullable
chargingPeriodIntervalInMinutes int32 nullable
stateofChargeIsSent boolean nullable
integrationType string

Possible values: [OCPI, UtilityCloud, Salesforce]

Default value: OCPI

integrationName string
approvedPartyId int64
ocpiConnection object
endpointUrl string
initialToken string
initialRole string
customerRoles string[]
platformIntegrationId string
thirdPartyId string
thirdPartyCountryCode string
chargingPeriodIntervalInMinutes int32 nullable
stateOfChargeIsSent boolean
utilityCloudConnection object
tenant string
clientId string
clientSecret string
meteredValuesAreSent boolean nullable
activateConnection boolean nullable
salesforceConnection object
endpointUrl string
activateConnection boolean nullable

Responses

• 200
• 400
• 401
• 404

---

Updated integration details

application/json

Schema

Example (from schema)

---

Schema

id string
integrationName string
integrationType string

Possible values: [OCPI, UtilityCloud, Salesforce]

Default value: OCPI

integrationStatus string
statusDescription string
approvedPartyId int64 nullable
customerRoles string[]

Possible values: [OpenData, CPO, EMSP, HUB, NAP, NSP, OTHER, SCSP, UNDEFINED]

locations object[]
Array [
id string
name string
publish boolean
publishAllowedTo object[]
Array [
uid string
type string
Possible values: [AD_HOC_USER, APP_USER, OTHER, RFID]
Default value: AD_HOC_USER
visualNumber string
issuer string
groupId string
]
address string
city string
postalCode string
state string
country string
coordinates object
latitude string
longitude string
relatedLocations object[]
Array [
latitude string
longitude string
name object
language string
text string
]
parkingType string nullable
Possible values: [ALONG_MOTORWAY, PARKING_GARAGE, PARKING_LOT, ON_DRIVEWAY, ON_STREET, UNDERGROUND_GARAGE, OTHER, UNKNOWN]
Default value: ALONG_MOTORWAY
directions object[]
Array [
language string
text string
]
suboperator object
name string
website uri
logo object
url uri
thumbnail uri
category string
Possible values: [CHARGER, ENTRANCE, LOCATION, NETWORK, OPERATOR, OTHER, OWNER]
Default value: CHARGER
type string
width int32
height int32
owner object
name string
website uri
logo object
url uri
thumbnail uri
category string
Possible values: [CHARGER, ENTRANCE, LOCATION, NETWORK, OPERATOR, OTHER, OWNER]
Default value: CHARGER
type string
width int32
height int32
facilities string[]
Possible values: [HOTEL, RESTAURANT, CAFE, MALL, SUPERMARKET, SPORT, RECREATION_AREA, NATURE, MUSEUM, BIKE_SHARING, BUS_STOP, TAXI_STAND, TRAM_STOP, METRO_STATION, TRAIN_STATION, AIRPORT, PARKING_LOT, CARPOOL_PARKING, FUEL_STATION, WIFI]
timezone string
openingTimes object
twentyfourseven boolean
regularHours object[]
Array [
weekday int32
periodBegin string
periodEnd string
]
exceptionalOpenings object[]
Array [
periodBegin date-time
periodEnd date-time
]
exceptionalClosings object[]
Array [
periodBegin date-time
periodEnd date-time
]
chargingWhenClosed boolean nullable
images object[]
Array [
url uri
thumbnail uri
category string
Possible values: [CHARGER, ENTRANCE, LOCATION, NETWORK, OPERATOR, OTHER, OWNER]
Default value: CHARGER
type string
width int32
height int32
]
locationEnergyMix object
isGreenEnergy boolean
energySources object[]
Array [
source string
Possible values: [NUCLEAR, GENERAL_FOSSIL, COAL, GAS, GENERAL_GREEN, SOLAR, WIND, WATER]
Default value: NUCLEAR
percentage float
]
environImpact object[]
Array [
category string
Possible values: [NUCLEAR_WASTE, CARBON_DIOXIDE]
Default value: NUCLEAR_WASTE
amount float
]
supplierName string
energyProductName string
evses object[]
Array [
chargerId string
connector object[]
Array [
id string
tariffIds string[]
]
]
externalId string
lastUpdated date-time
integrationId string
]
versionDetails object
version string
endpoints object[]
Array [
identifier string
Possible values: [cdrs, chargingprofiles, commands, credentials, hubclientinfo, locations, sessions, tariffs, tokens]
Default value: cdrs
role string nullable
Possible values: [SENDER, RECEIVER, BOTH]
Default value: SENDER
url uri
]
credentialsInfo object
initialToken string
initialRole string
ourToken string
theirToken string
url uri
credentialsRoles object[]
Array [
role string
Possible values: [OpenData, CPO, EMSP, HUB, NAP, NSP, OTHER, SCSP, UNDEFINED]
Default value: OpenData
party_id string
country_code string
business_details object
name string
website uri
logo object
url uri
thumbnail uri
category string
Possible values: [CHARGER, ENTRANCE, LOCATION, NETWORK, OPERATOR, OTHER, OWNER]
Default value: CHARGER
type string
width int32
height int32
]
billingConnection object
tenant string
clientId string
clientSecret string
scope string
meterValuesAreSent boolean nullable
partyPlatform object
platformIntegrationId string
partyId string
countryCode string
tariffs object[]
Array [
id string
externalId string
currency string
type string nullable
Possible values: [AD_HOC_PAYMENT, PROFILE_CHEAP, PROFILE_FAST, PROFILE_GREEN, REGULAR]
Default value: AD_HOC_PAYMENT
tariffAltText object[]
Array [
language string
text string
]
tariffAltUrl uri
minPrice object
exclVat float
inclVat float nullable
maxPrice object
exclVat float
inclVat float nullable
elements object[]
Array [
priceComponents object[]
Array [
type string
Possible values: [ENERGY, FLAT, PARKING_TIME, TIME]
Default value: ENERGY
price float
vat float nullable
stepSize int32
]
restrictions object
startTime string
endTime string
startDate string
endDate string
minKwh double nullable
maxKwh double nullable
minCurrent double nullable
maxCurrent double nullable
minPower double nullable
maxPower double nullable
minDuration int32 nullable
maxDuration int32 nullable
dayOfWeek string[]
Possible values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
reservation string nullable
Possible values: [RESERVATION, RESERVATION_EXPIRES]
Default value: RESERVATION
]
startDateTime date-time nullable
endDateTime date-time nullable
tariffEnergyMix object
isGreenEnergy boolean
energySources object[]
Array [
source string
Possible values: [NUCLEAR, GENERAL_FOSSIL, COAL, GAS, GENERAL_GREEN, SOLAR, WIND, WATER]
Default value: NUCLEAR
percentage float
]
environImpact object[]
Array [
category string
Possible values: [NUCLEAR_WASTE, CARBON_DIOXIDE]
Default value: NUCLEAR_WASTE
amount float
]
supplierName string
energyProductName string
lastUpdated date-time
]
receivedTariffs object[]
Array [
id string
countryCode string
partyId string
currency string
type string nullable
Possible values: [AD_HOC_PAYMENT, PROFILE_CHEAP, PROFILE_FAST, PROFILE_GREEN, REGULAR]
Default value: AD_HOC_PAYMENT
tariffAltText object[]
Array [
language string
text string
]
tariffAltUrl uri
minPrice object
exclVat float
inclVat float nullable
maxPrice object
exclVat float
inclVat float nullable
elements object[]
Array [
priceComponents object[]
Array [
type string
Possible values: [ENERGY, FLAT, PARKING_TIME, TIME]
Default value: ENERGY
price float
vat float nullable
stepSize int32
]
restrictions object
startTime string
endTime string
startDate string
endDate string
minKwh double nullable
maxKwh double nullable
minCurrent double nullable
maxCurrent double nullable
minPower double nullable
maxPower double nullable
minDuration int32 nullable
maxDuration int32 nullable
dayOfWeek string[]
Possible values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
reservation string nullable
Possible values: [RESERVATION, RESERVATION_EXPIRES]
Default value: RESERVATION
]
startDateTime date-time nullable
endDateTime date-time nullable
tariffEnergyMix object
isGreenEnergy boolean
energySources object[]
Array [
source string
Possible values: [NUCLEAR, GENERAL_FOSSIL, COAL, GAS, GENERAL_GREEN, SOLAR, WIND, WATER]
Default value: NUCLEAR
percentage float
]
environImpact object[]
Array [
category string
Possible values: [NUCLEAR_WASTE, CARBON_DIOXIDE]
Default value: NUCLEAR_WASTE
amount float
]
supplierName string
energyProductName string
lastUpdated date-time
]
models object
pushCdr boolean nullable
pushSession boolean nullable
pushTariff boolean nullable
pushLocation boolean nullable
pullTokensAll boolean nullable
pullTariff boolean nullable
pullLocation boolean nullable
pullSession boolean nullable
pullCdr boolean nullable
pullVersionDetails boolean nullable
chargingPeriodIntervalInMinutes int32 nullable
stateofChargeIsSent boolean nullable
freeVendingWithIdtagAllowed boolean nullable
created date-time nullable
lastUpdated date-time nullable

{
  "id": "string",
  "integrationName": "string",
  "integrationType": "OCPI",
  "integrationStatus": "string",
  "statusDescription": "string",
  "approvedPartyId": 0,
  "customerRoles": [
    "OpenData"
  ],
  "locations": [
    {
      "id": "string",
      "name": "string",
      "publish": true,
      "publishAllowedTo": [
        {
          "uid": "string",
          "type": "AD_HOC_USER",
          "visualNumber": "string",
          "issuer": "string",
          "groupId": "string"
        }
      ],
      "address": "string",
      "city": "string",
      "postalCode": "string",
      "state": "string",
      "country": "string",
      "coordinates": {
        "latitude": "string",
        "longitude": "string"
      },
      "relatedLocations": [
        {
          "latitude": "string",
          "longitude": "string",
          "name": {
            "language": "string",
            "text": "string"
          }
        }
      ],
      "parkingType": "ALONG_MOTORWAY",
      "directions": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "suboperator": {
        "name": "string",
        "website": "string",
        "logo": {
          "url": "string",
          "thumbnail": "string",
          "category": "CHARGER",
          "type": "string",
          "width": 0,
          "height": 0
        }
      },
      "owner": {
        "name": "string",
        "website": "string",
        "logo": {
          "url": "string",
          "thumbnail": "string",
          "category": "CHARGER",
          "type": "string",
          "width": 0,
          "height": 0
        }
      },
      "facilities": [
        "HOTEL"
      ],
      "timezone": "string",
      "openingTimes": {
        "twentyfourseven": true,
        "regularHours": [
          {
            "weekday": 0,
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ],
        "exceptionalOpenings": [
          {
            "periodBegin": "2025-05-28T10:55:51.225Z",
            "periodEnd": "2025-05-28T10:55:51.225Z"
          }
        ],
        "exceptionalClosings": [
          {
            "periodBegin": "2025-05-28T10:55:51.225Z",
            "periodEnd": "2025-05-28T10:55:51.225Z"
          }
        ]
      },
      "chargingWhenClosed": true,
      "images": [
        {
          "url": "string",
          "thumbnail": "string",
          "category": "CHARGER",
          "type": "string",
          "width": 0,
          "height": 0
        }
      ],
      "locationEnergyMix": {
        "isGreenEnergy": true,
        "energySources": [
          {
            "source": "NUCLEAR",
            "percentage": 0
          }
        ],
        "environImpact": [
          {
            "category": "NUCLEAR_WASTE",
            "amount": 0
          }
        ],
        "supplierName": "string",
        "energyProductName": "string"
      },
      "evses": [
        {
          "chargerId": "string",
          "connector": [
            {
              "id": "string",
              "tariffIds": [
                "string"
              ]
            }
          ]
        }
      ],
      "externalId": "string",
      "lastUpdated": "2025-05-28T10:55:51.225Z",
      "integrationId": "string"
    }
  ],
  "versionDetails": {
    "version": "string",
    "endpoints": [
      {
        "identifier": "cdrs",
        "role": "SENDER",
        "url": "string"
      }
    ]
  },
  "credentialsInfo": {
    "initialToken": "string",
    "initialRole": "string",
    "ourToken": "string",
    "theirToken": "string",
    "url": "string",
    "credentialsRoles": [
      {
        "role": "OpenData",
        "party_id": "string",
        "country_code": "string",
        "business_details": {
          "name": "string",
          "website": "string",
          "logo": {
            "url": "string",
            "thumbnail": "string",
            "category": "CHARGER",
            "type": "string",
            "width": 0,
            "height": 0
          }
        }
      }
    ]
  },
  "billingConnection": {
    "tenant": "string",
    "clientId": "string",
    "clientSecret": "string",
    "scope": "string",
    "meterValuesAreSent": true
  },
  "partyPlatform": {
    "platformIntegrationId": "string",
    "partyId": "string",
    "countryCode": "string"
  },
  "tariffs": [
    {
      "id": "string",
      "externalId": "string",
      "currency": "string",
      "type": "AD_HOC_PAYMENT",
      "tariffAltText": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "tariffAltUrl": "string",
      "minPrice": {
        "exclVat": 0,
        "inclVat": 0
      },
      "maxPrice": {
        "exclVat": 0,
        "inclVat": 0
      },
      "elements": [
        {
          "priceComponents": [
            {
              "type": "ENERGY",
              "price": 0,
              "vat": 0,
              "stepSize": 0
            }
          ],
          "restrictions": {
            "startTime": "string",
            "endTime": "string",
            "startDate": "string",
            "endDate": "string",
            "minKwh": 0,
            "maxKwh": 0,
            "minCurrent": 0,
            "maxCurrent": 0,
            "minPower": 0,
            "maxPower": 0,
            "minDuration": 0,
            "maxDuration": 0,
            "dayOfWeek": [
              "MONDAY"
            ],
            "reservation": "RESERVATION"
          }
        }
      ],
      "startDateTime": "2025-05-28T10:55:51.225Z",
      "endDateTime": "2025-05-28T10:55:51.225Z",
      "tariffEnergyMix": {
        "isGreenEnergy": true,
        "energySources": [
          {
            "source": "NUCLEAR",
            "percentage": 0
          }
        ],
        "environImpact": [
          {
            "category": "NUCLEAR_WASTE",
            "amount": 0
          }
        ],
        "supplierName": "string",
        "energyProductName": "string"
      },
      "lastUpdated": "2025-05-28T10:55:51.225Z"
    }
  ],
  "receivedTariffs": [
    {
      "id": "string",
      "countryCode": "string",
      "partyId": "string",
      "currency": "string",
      "type": "AD_HOC_PAYMENT",
      "tariffAltText": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "tariffAltUrl": "string",
      "minPrice": {
        "exclVat": 0,
        "inclVat": 0
      },
      "maxPrice": {
        "exclVat": 0,
        "inclVat": 0
      },
      "elements": [
        {
          "priceComponents": [
            {
              "type": "ENERGY",
              "price": 0,
              "vat": 0,
              "stepSize": 0
            }
          ],
          "restrictions": {
            "startTime": "string",
            "endTime": "string",
            "startDate": "string",
            "endDate": "string",
            "minKwh": 0,
            "maxKwh": 0,
            "minCurrent": 0,
            "maxCurrent": 0,
            "minPower": 0,
            "maxPower": 0,
            "minDuration": 0,
            "maxDuration": 0,
            "dayOfWeek": [
              "MONDAY"
            ],
            "reservation": "RESERVATION"
          }
        }
      ],
      "startDateTime": "2025-05-28T10:55:51.225Z",
      "endDateTime": "2025-05-28T10:55:51.225Z",
      "tariffEnergyMix": {
        "isGreenEnergy": true,
        "energySources": [
          {
            "source": "NUCLEAR",
            "percentage": 0
          }
        ],
        "environImpact": [
          {
            "category": "NUCLEAR_WASTE",
            "amount": 0
          }
        ],
        "supplierName": "string",
        "energyProductName": "string"
      },
      "lastUpdated": "2025-05-28T10:55:51.225Z"
    }
  ],
  "models": {
    "pushCdr": true,
    "pushSession": true,
    "pushTariff": true,
    "pushLocation": true,
    "pullTokensAll": true,
    "pullTariff": true,
    "pullLocation": true,
    "pullSession": true,
    "pullCdr": true,
    "pullVersionDetails": true
  },
  "chargingPeriodIntervalInMinutes": 0,
  "stateofChargeIsSent": true,
  "freeVendingWithIdtagAllowed": true,
  "created": "2025-05-28T10:55:51.225Z",
  "lastUpdated": "2025-05-28T10:55:51.225Z"
}

Validation error occurred.

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

User not authorized.

Integration not found.

Loading...