Update a Connect session

curl --request PATCH \
  --url https://energy-api.flatpeak.com/connect-sessions/{session_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "device_id": "dev_63a6087272941ef077a8fd3e",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "supplier_id": "sup_6a2be12ecf43cb7e3d6cefcd",
  "connect_url": "myapp://nova/flatpeak/connect",
  "callback_url": "myapp://nova/flatpeak/complete"
}
'

import requests

url = "https://energy-api.flatpeak.com/connect-sessions/{session_id}"

payload = {
    "device_id": "dev_63a6087272941ef077a8fd3e",
    "location_id": "loc_641b90b758fb8e6293716e40",
    "supplier_id": "sup_6a2be12ecf43cb7e3d6cefcd",
    "connect_url": "myapp://nova/flatpeak/connect",
    "callback_url": "myapp://nova/flatpeak/complete"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    device_id: 'dev_63a6087272941ef077a8fd3e',
    location_id: 'loc_641b90b758fb8e6293716e40',
    supplier_id: 'sup_6a2be12ecf43cb7e3d6cefcd',
    connect_url: 'myapp://nova/flatpeak/connect',
    callback_url: 'myapp://nova/flatpeak/complete'
  })
};

fetch('https://energy-api.flatpeak.com/connect-sessions/{session_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://energy-api.flatpeak.com/connect-sessions/{session_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([
    'device_id' => 'dev_63a6087272941ef077a8fd3e',
    'location_id' => 'loc_641b90b758fb8e6293716e40',
    'supplier_id' => 'sup_6a2be12ecf43cb7e3d6cefcd',
    'connect_url' => 'myapp://nova/flatpeak/connect',
    'callback_url' => 'myapp://nova/flatpeak/complete'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://energy-api.flatpeak.com/connect-sessions/{session_id}"

	payload := strings.NewReader("{\n  \"device_id\": \"dev_63a6087272941ef077a8fd3e\",\n  \"location_id\": \"loc_641b90b758fb8e6293716e40\",\n  \"supplier_id\": \"sup_6a2be12ecf43cb7e3d6cefcd\",\n  \"connect_url\": \"myapp://nova/flatpeak/connect\",\n  \"callback_url\": \"myapp://nova/flatpeak/complete\"\n}")

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

	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://energy-api.flatpeak.com/connect-sessions/{session_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"device_id\": \"dev_63a6087272941ef077a8fd3e\",\n  \"location_id\": \"loc_641b90b758fb8e6293716e40\",\n  \"supplier_id\": \"sup_6a2be12ecf43cb7e3d6cefcd\",\n  \"connect_url\": \"myapp://nova/flatpeak/connect\",\n  \"callback_url\": \"myapp://nova/flatpeak/complete\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://energy-api.flatpeak.com/connect-sessions/{session_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"device_id\": \"dev_63a6087272941ef077a8fd3e\",\n  \"location_id\": \"loc_641b90b758fb8e6293716e40\",\n  \"supplier_id\": \"sup_6a2be12ecf43cb7e3d6cefcd\",\n  \"connect_url\": \"myapp://nova/flatpeak/connect\",\n  \"callback_url\": \"myapp://nova/flatpeak/complete\"\n}"

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

{
  "id": "cos_6a3196d6e61a44f33f7307ed",
  "object": "connect_session",
  "live_mode": true,
  "location_id": "loc_641b90b758fb8e6293716e40",
  "time_created": "2026-05-05T18:37:27Z",
  "time_expiry": "2026-12-28T03:00:00Z",
  "price_available": true,
  "device_id": "dev_63a6087272941ef077a8fd3e",
  "supplier_id": "sup_6a2b2460ba2259a0c4980afb",
  "connect_url": "myapp://nova/flatpeak/connect",
  "callback_url": "myapp://nova/flatpeak/complete"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

PATCH

connect-sessions

{session_id}

Update a Connect session

curl --request PATCH \
  --url https://energy-api.flatpeak.com/connect-sessions/{session_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "device_id": "dev_63a6087272941ef077a8fd3e",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "supplier_id": "sup_6a2be12ecf43cb7e3d6cefcd",
  "connect_url": "myapp://nova/flatpeak/connect",
  "callback_url": "myapp://nova/flatpeak/complete"
}
'

import requests

url = "https://energy-api.flatpeak.com/connect-sessions/{session_id}"

payload = {
    "device_id": "dev_63a6087272941ef077a8fd3e",
    "location_id": "loc_641b90b758fb8e6293716e40",
    "supplier_id": "sup_6a2be12ecf43cb7e3d6cefcd",
    "connect_url": "myapp://nova/flatpeak/connect",
    "callback_url": "myapp://nova/flatpeak/complete"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    device_id: 'dev_63a6087272941ef077a8fd3e',
    location_id: 'loc_641b90b758fb8e6293716e40',
    supplier_id: 'sup_6a2be12ecf43cb7e3d6cefcd',
    connect_url: 'myapp://nova/flatpeak/connect',
    callback_url: 'myapp://nova/flatpeak/complete'
  })
};

fetch('https://energy-api.flatpeak.com/connect-sessions/{session_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://energy-api.flatpeak.com/connect-sessions/{session_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([
    'device_id' => 'dev_63a6087272941ef077a8fd3e',
    'location_id' => 'loc_641b90b758fb8e6293716e40',
    'supplier_id' => 'sup_6a2be12ecf43cb7e3d6cefcd',
    'connect_url' => 'myapp://nova/flatpeak/connect',
    'callback_url' => 'myapp://nova/flatpeak/complete'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://energy-api.flatpeak.com/connect-sessions/{session_id}"

	payload := strings.NewReader("{\n  \"device_id\": \"dev_63a6087272941ef077a8fd3e\",\n  \"location_id\": \"loc_641b90b758fb8e6293716e40\",\n  \"supplier_id\": \"sup_6a2be12ecf43cb7e3d6cefcd\",\n  \"connect_url\": \"myapp://nova/flatpeak/connect\",\n  \"callback_url\": \"myapp://nova/flatpeak/complete\"\n}")

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

	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://energy-api.flatpeak.com/connect-sessions/{session_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"device_id\": \"dev_63a6087272941ef077a8fd3e\",\n  \"location_id\": \"loc_641b90b758fb8e6293716e40\",\n  \"supplier_id\": \"sup_6a2be12ecf43cb7e3d6cefcd\",\n  \"connect_url\": \"myapp://nova/flatpeak/connect\",\n  \"callback_url\": \"myapp://nova/flatpeak/complete\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://energy-api.flatpeak.com/connect-sessions/{session_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"device_id\": \"dev_63a6087272941ef077a8fd3e\",\n  \"location_id\": \"loc_641b90b758fb8e6293716e40\",\n  \"supplier_id\": \"sup_6a2be12ecf43cb7e3d6cefcd\",\n  \"connect_url\": \"myapp://nova/flatpeak/connect\",\n  \"callback_url\": \"myapp://nova/flatpeak/complete\"\n}"

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

{
  "id": "cos_6a3196d6e61a44f33f7307ed",
  "object": "connect_session",
  "live_mode": true,
  "location_id": "loc_641b90b758fb8e6293716e40",
  "time_created": "2026-05-05T18:37:27Z",
  "time_expiry": "2026-12-28T03:00:00Z",
  "price_available": true,
  "device_id": "dev_63a6087272941ef077a8fd3e",
  "supplier_id": "sup_6a2b2460ba2259a0c4980afb",
  "connect_url": "myapp://nova/flatpeak/connect",
  "callback_url": "myapp://nova/flatpeak/complete"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "not_found",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

Authorizations

Authorization

string

header

required

Bearer token obtained from POST /auth/tokens.

Path Parameters

session_id

string

required

Flatpeak Connect session ID.

Body

application/json

Connect init session data.

device_id

string

Flatpeak Device ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$

Example:

"dev_63a6087272941ef077a8fd3e"

location_id

string

Flatpeak Location ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$

Example:

"loc_641b90b758fb8e6293716e40"

supplier_id

string

Flatpeak ID of the energy supplier to preselect in the TARIFF flow, so the user skips supplier selection. Optional.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$

Example:

"sup_6a2be12ecf43cb7e3d6cefcd"

connect_url

string

URL the user is redirected to during the Handling the callback step of the Redirect function: your Connect web app or a deep link into your native app.

Example:

"myapp://nova/flatpeak/connect"

callback_url

string

URL to redirect the user to after they complete or exit their Connect session.

Example:

"myapp://nova/flatpeak/complete"

Response

Connect session response.

string

required

Flatpeak Connect session ID.

Example:

"cos_6a3196d6e61a44f33f7307ed"

object

string

required

Object type.

Example:

"connect_session"

live_mode

boolean

required

true for live data, false for test data.

Example:

true

location_id

string

required

Flatpeak Location ID.

Example:

"loc_641b90b758fb8e6293716e40"

time_created

string<date-time>

required

Time when the object was created, in UTC.

Example:

"2026-05-05T18:37:27Z"

time_expiry

string<date-time>

required

Time when the session expires.

Example:

"2026-12-28T03:00:00Z"

price_available

boolean

required

true when prices are available to fetch.

device_id

string

Flatpeak Device ID.

Example:

"dev_63a6087272941ef077a8fd3e"

supplier_id

string

Flatpeak ID of the energy supplier preselected for the TARIFF flow, when one was passed.

Example:

"sup_6a2b2460ba2259a0c4980afb"

connect_url

string

URL the user is redirected to during the Handling the callback step of the Redirect function: your Connect web app or a deep link into your native app.

Example:

"myapp://nova/flatpeak/connect"

callback_url

string

URL to redirect the user to after they complete or exit their Connect session.

Example:

"myapp://nova/flatpeak/complete"

Platform

Tariffs

VPP

Update a Connect session

Authorizations

Path Parameters

Body

Response