Skip to main content
PUT
/
networks
/
channels
/
{channelId}
Update Channel
curl --request PUT \
  --url https://api.eflow.team/v1/networks/channels/{channelId} \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "name": "TestChannel",
  "status": "inactive"
}
'
import requests

url = "https://api.eflow.team/v1/networks/channels/{channelId}"

payload = {
"name": "TestChannel",
"status": "inactive"
}
headers = {
"X-Eflow-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {'X-Eflow-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'TestChannel', status: 'inactive'})
};

fetch('https://api.eflow.team/v1/networks/channels/{channelId}', 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.eflow.team/v1/networks/channels/{channelId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'TestChannel',
'status' => 'inactive'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Eflow-Api-Key: <api-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.eflow.team/v1/networks/channels/{channelId}"

payload := strings.NewReader("{\n \"name\": \"TestChannel\",\n \"status\": \"inactive\"\n}")

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

req.Header.Add("X-Eflow-Api-Key", "<api-key>")
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.put("https://api.eflow.team/v1/networks/channels/{channelId}")
.header("X-Eflow-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"TestChannel\",\n \"status\": \"inactive\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.eflow.team/v1/networks/channels/{channelId}")

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

request = Net::HTTP::Put.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"TestChannel\",\n \"status\": \"inactive\"\n}"

response = http.request(request)
puts response.read_body
{
  "network_channel_id": 1,
  "network_id": 1,
  "name": "TestChannel",
  "status": "inactive",
  "time_created": 1774712750,
  "time_saved": 1774712800,
  "relationship": {}
}
Update an existing channel. This is a full object replacement; all fields must be provided in the request body.

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Path Parameters

channelId
integer
required

The ID of the channel to update.

Body

application/json
name
string
required

Name of the channel.

status
enum<string>
required

Status of the channel.

Available options:
active,
inactive

Response

200 - application/json

A traffic channel in the network.

network_channel_id
integer

Unique channel ID.

network_id
integer

Network ID.

name
string

Channel name.

status
enum<string>

Channel status.

Available options:
active,
inactive
time_created
integer

Unix timestamp of creation.

Example:

1734455015

time_saved
integer

Unix timestamp of last update.

Example:

1734455015

relationship
object

Related data.