curl --request DELETE \
--url 'https://api.edgeful.com/v1/settings/custom-sessions/<id>' \
--header 'Authorization: Bearer <api-key>'import requests
url = "https://api.edgeful.com/v1/settings/custom-sessions/<id>"
headers = {"Authorization": "Bearer <api-key>"}
response = requests.delete(url, headers=headers)
print(response.json())const url = "https://api.edgeful.com/v1/settings/custom-sessions/<id>";
const options = {
method: "DELETE",
headers: { Authorization: "Bearer <api-key>" },
};
const response = await fetch(url, options);
const data = await response.json();
console.log(data);<?php
$ch = curl_init("https://api.edgeful.com/v1/settings/custom-sessions/<id>");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://api.edgeful.com/v1/settings/custom-sessions/<id>", nil)
req.Header.Set("Authorization", "Bearer <api-key>")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.edgeful.com/v1/settings/custom-sessions/<id>"))
.header("Authorization", "Bearer <api-key>")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());require "net/http"
require "uri"
uri = URI("https://api.edgeful.com/v1/settings/custom-sessions/<id>")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer <api-key>"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"status": "<string>",
"removed": {
"id": "<string>",
"name": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"timezone": "<string>",
"excludedDataTypes": [
"<string>"
]
},
"custom_sessions": [
{
"id": "<string>",
"name": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"timezone": "<string>",
"excludedDataTypes": [
"<string>"
]
}
],
"referencing_templates": [
{
"id": 123,
"type": "<string>",
"name": "<string>",
"parent_report": "<string>",
"sub_report": "<string>"
}
],
"changed": {
"saved": [
"<string>"
],
"removed": [
"<string>"
]
}
}delete custom session
delete one custom session by id. returns the removed session so it can be saved again under a new id, the remaining list and the templates that still reference it; a missing id changes nothing. this changes your account, and Edgeful shows the change after a reload. requires the key’s write permission.
curl --request DELETE \
--url 'https://api.edgeful.com/v1/settings/custom-sessions/<id>' \
--header 'Authorization: Bearer <api-key>'import requests
url = "https://api.edgeful.com/v1/settings/custom-sessions/<id>"
headers = {"Authorization": "Bearer <api-key>"}
response = requests.delete(url, headers=headers)
print(response.json())const url = "https://api.edgeful.com/v1/settings/custom-sessions/<id>";
const options = {
method: "DELETE",
headers: { Authorization: "Bearer <api-key>" },
};
const response = await fetch(url, options);
const data = await response.json();
console.log(data);<?php
$ch = curl_init("https://api.edgeful.com/v1/settings/custom-sessions/<id>");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://api.edgeful.com/v1/settings/custom-sessions/<id>", nil)
req.Header.Set("Authorization", "Bearer <api-key>")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.edgeful.com/v1/settings/custom-sessions/<id>"))
.header("Authorization", "Bearer <api-key>")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());require "net/http"
require "uri"
uri = URI("https://api.edgeful.com/v1/settings/custom-sessions/<id>")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer <api-key>"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"status": "<string>",
"removed": {
"id": "<string>",
"name": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"timezone": "<string>",
"excludedDataTypes": [
"<string>"
]
},
"custom_sessions": [
{
"id": "<string>",
"name": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"timezone": "<string>",
"excludedDataTypes": [
"<string>"
]
}
],
"referencing_templates": [
{
"id": 123,
"type": "<string>",
"name": "<string>",
"parent_report": "<string>",
"sub_report": "<string>"
}
],
"changed": {
"saved": [
"<string>"
],
"removed": [
"<string>"
]
}
}Authorizations
Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).
Path Parameters
the custom session's id.
1 - 80Response
Successful Response
deleted or unchanged.
the removed session, for recreating it; null when the id was unknown.
Show child attributes
Show child attributes
every custom session after this write.
Show child attributes
Show child attributes
templates that still reference the session.
Show child attributes
Show child attributes
what this write changed.
Show child attributes
Show child attributes
Was this page helpful?