Update network settings

curl --request PATCH \
  --url https://api.spirii.com/emsp/v1/networks/{network_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "publicly_accessible": true,
  "cpo_ids": [
    "<string>"
  ],
  "countries": [
    "<string>"
  ],
  "power_types": [
    "<string>"
  ],
  "parking_types": [
    "<string>"
  ],
  "facilities": [
    "<string>"
  ],
  "auto_accept_cpo_additions": true
}
'

import requests

url = "https://api.spirii.com/emsp/v1/networks/{network_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "publicly_accessible": True,
    "cpo_ids": ["<string>"],
    "countries": ["<string>"],
    "power_types": ["<string>"],
    "parking_types": ["<string>"],
    "facilities": ["<string>"],
    "auto_accept_cpo_additions": True
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    publicly_accessible: true,
    cpo_ids: ['<string>'],
    countries: ['<string>'],
    power_types: ['<string>'],
    parking_types: ['<string>'],
    facilities: ['<string>'],
    auto_accept_cpo_additions: true
  })
};

fetch('https://api.spirii.com/emsp/v1/networks/{network_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.spirii.com/emsp/v1/networks/{network_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'publicly_accessible' => true,
    'cpo_ids' => [
        '<string>'
    ],
    'countries' => [
        '<string>'
    ],
    'power_types' => [
        '<string>'
    ],
    'parking_types' => [
        '<string>'
    ],
    'facilities' => [
        '<string>'
    ],
    'auto_accept_cpo_additions' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spirii.com/emsp/v1/networks/{network_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"publicly_accessible\": true,\n  \"cpo_ids\": [\n    \"<string>\"\n  ],\n  \"countries\": [\n    \"<string>\"\n  ],\n  \"power_types\": [\n    \"<string>\"\n  ],\n  \"parking_types\": [\n    \"<string>\"\n  ],\n  \"facilities\": [\n    \"<string>\"\n  ],\n  \"auto_accept_cpo_additions\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.spirii.com/emsp/v1/networks/{network_id}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"publicly_accessible\": true,\n  \"cpo_ids\": [\n    \"<string>\"\n  ],\n  \"countries\": [\n    \"<string>\"\n  ],\n  \"power_types\": [\n    \"<string>\"\n  ],\n  \"parking_types\": [\n    \"<string>\"\n  ],\n  \"facilities\": [\n    \"<string>\"\n  ],\n  \"auto_accept_cpo_additions\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spirii.com/emsp/v1/networks/{network_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"publicly_accessible\": true,\n  \"cpo_ids\": [\n    \"<string>\"\n  ],\n  \"countries\": [\n    \"<string>\"\n  ],\n  \"power_types\": [\n    \"<string>\"\n  ],\n  \"parking_types\": [\n    \"<string>\"\n  ],\n  \"facilities\": [\n    \"<string>\"\n  ],\n  \"auto_accept_cpo_additions\": true\n}"

response = http.request(request)
puts response.read_body

{
  "network_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "network_type": "BASE",
  "published": true,
  "publish_state": "PUBLISHED",
  "unpublish_started_at": "2023-11-07T05:31:56Z",
  "unpublish_drain_until": "2023-11-07T05:31:56Z",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "emp_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "cpo_ids": [
    "<string>"
  ],
  "protocol": [
    "<string>"
  ],
  "roaming_hub": [
    "<string>"
  ],
  "publicly_accessible": true,
  "parent_network_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "countries": [
    "<string>"
  ],
  "power_types": [
    "<string>"
  ],
  "parking_types": [
    "<string>"
  ],
  "facilities": [
    "<string>"
  ],
  "auto_accept_cpo_additions": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Update network settings

Changes a network’s settings. What you can change depends on the network type: on a sub-network you can rename it, change its description, and adjust its operators; on a base network you can adjust the operators and whether its locations appear in anonymous charger searches — but not its name, which is derived from the roaming identity that owns it. When operators are removed from a base network, they’re automatically removed from every slice of it too; newly added operators only flow into slices that have opted in to receive them.

PATCH

emsp

networks

{network_id}

Update network settings

curl --request PATCH \
  --url https://api.spirii.com/emsp/v1/networks/{network_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "publicly_accessible": true,
  "cpo_ids": [
    "<string>"
  ],
  "countries": [
    "<string>"
  ],
  "power_types": [
    "<string>"
  ],
  "parking_types": [
    "<string>"
  ],
  "facilities": [
    "<string>"
  ],
  "auto_accept_cpo_additions": true
}
'

import requests

url = "https://api.spirii.com/emsp/v1/networks/{network_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "publicly_accessible": True,
    "cpo_ids": ["<string>"],
    "countries": ["<string>"],
    "power_types": ["<string>"],
    "parking_types": ["<string>"],
    "facilities": ["<string>"],
    "auto_accept_cpo_additions": True
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    publicly_accessible: true,
    cpo_ids: ['<string>'],
    countries: ['<string>'],
    power_types: ['<string>'],
    parking_types: ['<string>'],
    facilities: ['<string>'],
    auto_accept_cpo_additions: true
  })
};

fetch('https://api.spirii.com/emsp/v1/networks/{network_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.spirii.com/emsp/v1/networks/{network_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'publicly_accessible' => true,
    'cpo_ids' => [
        '<string>'
    ],
    'countries' => [
        '<string>'
    ],
    'power_types' => [
        '<string>'
    ],
    'parking_types' => [
        '<string>'
    ],
    'facilities' => [
        '<string>'
    ],
    'auto_accept_cpo_additions' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spirii.com/emsp/v1/networks/{network_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"publicly_accessible\": true,\n  \"cpo_ids\": [\n    \"<string>\"\n  ],\n  \"countries\": [\n    \"<string>\"\n  ],\n  \"power_types\": [\n    \"<string>\"\n  ],\n  \"parking_types\": [\n    \"<string>\"\n  ],\n  \"facilities\": [\n    \"<string>\"\n  ],\n  \"auto_accept_cpo_additions\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.spirii.com/emsp/v1/networks/{network_id}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"publicly_accessible\": true,\n  \"cpo_ids\": [\n    \"<string>\"\n  ],\n  \"countries\": [\n    \"<string>\"\n  ],\n  \"power_types\": [\n    \"<string>\"\n  ],\n  \"parking_types\": [\n    \"<string>\"\n  ],\n  \"facilities\": [\n    \"<string>\"\n  ],\n  \"auto_accept_cpo_additions\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spirii.com/emsp/v1/networks/{network_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"publicly_accessible\": true,\n  \"cpo_ids\": [\n    \"<string>\"\n  ],\n  \"countries\": [\n    \"<string>\"\n  ],\n  \"power_types\": [\n    \"<string>\"\n  ],\n  \"parking_types\": [\n    \"<string>\"\n  ],\n  \"facilities\": [\n    \"<string>\"\n  ],\n  \"auto_accept_cpo_additions\": true\n}"

response = http.request(request)
puts response.read_body

{
  "network_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "network_type": "BASE",
  "published": true,
  "publish_state": "PUBLISHED",
  "unpublish_started_at": "2023-11-07T05:31:56Z",
  "unpublish_drain_until": "2023-11-07T05:31:56Z",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "emp_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "cpo_ids": [
    "<string>"
  ],
  "protocol": [
    "<string>"
  ],
  "roaming_hub": [
    "<string>"
  ],
  "publicly_accessible": true,
  "parent_network_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "countries": [
    "<string>"
  ],
  "power_types": [
    "<string>"
  ],
  "parking_types": [
    "<string>"
  ],
  "facilities": [
    "<string>"
  ],
  "auto_accept_cpo_additions": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key

string<uuid>

required

Client-generated unique key per operation intent (UUID). Same key + identical body replays the original response; same key + different body returns 409.

Path Parameters

network_id

string<uuid>

required

The unique ID of the network to update.

Body

application/json

name

string

Maximum string length: 255

description

string | null

Maximum string length: 1000

publicly_accessible

boolean

Whether locations in this network are included in anonymous location discovery. Applies to BASE and SUB networks.

cpo_ids

string[]

Operator IDs of CPOs belonging to this network. SUB networks only.

countries

string[]

Countries covered. SUB networks only.

power_types

string[]

Power types. SUB networks only.

parking_types

string[]

Parking types. SUB networks only.

facilities

string[]

Facilities. SUB networks only.

auto_accept_cpo_additions

boolean

When true, cpo_ids added to the parent BASE network are auto-added to this sub. SUB networks only.

Response

The updated network. Fires network.updated webhook.

network_id

string<uuid>

required

Network identifier.

name

string

required

BASE network name (auto-derived from the emp_identity and immutable) or the creator-set SUB network name.

network_type

enum<string>

required

Network kind.

Available options:

BASE,

SUB

published

boolean

required

Whether a BASE network is currently published. Always false for SUB networks.

publish_state

enum<string> | null

required

Publish lifecycle state for BASE networks; null for SUB networks.

Available options:

PUBLISHED,

UNPUBLISHED,

UNPUBLISHING

unpublish_started_at

string<date-time> | null

required

When the current unpublish (drain) was started, if any.

unpublish_drain_until

string<date-time> | null

required

When the unpublish drain window ends, after which the network is fully unpublished.

tenant_id

string<uuid>

required

Owning tenant identifier.

emp_identity_id

string<uuid>

required

emp_identity the network belongs to.

description

string | null

required

Free-text description.

cpo_ids

string[]

required

Operator IDs (eMI3, e.g. DK*SPI) of the CPOs in this network.

protocol

string[]

required

Roaming protocols carried by the network.

roaming_hub

string[]

required

Roaming hubs the network is reachable through.

publicly_accessible

boolean

required

Whether the network is publicly accessible.

parent_network_id

string<uuid> | null

required

Parent BASE network for a SUB network; null for BASE networks.

countries

string[]

required

ISO 3166-1 country codes the network covers.

power_types

string[]

required

Power types the network filters on.

parking_types

string[]

required

Parking types the network filters on.

facilities

string[]

required

Facilities the network filters on.

auto_accept_cpo_additions

boolean

required

Whether newly-available CPOs are auto-accepted into the network.

created_at

string<date-time>

required

Creation timestamp (UTC).

updated_at

string<date-time>

required

Last-update timestamp (UTC).

Get started

Spirii API

EMSP API

Billing API

Energy Management API

Legacy API

Update network settings

Authorizations

Headers

Path Parameters

Body

Response