Connected Channels API

Set Connected Channel Mode

Set the mode of an existing channel connection. Use CONNECTED_SERVICE_MODE_FULL_ASSIST to activate Help desk (Always respond), or CONNECTED_SERVICE_MODE_DISABLED to disable it. The id is the Serval connection UUID, not the platform channel ID. Repeating the current mode is a no-op. Only platform-supported modes are accepted; redirect-to-DM requires a Slack DM surface. Does not create connections or invite the bot. Requires channels:write for scoped API keys.

PUT

/

v2

/

teams

/

{team_id}

/

connected-channels

/

{id}

/

mode

Set Connected Channel Mode

curl --request PUT \
  --url https://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode', 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://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode",
  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([
    
  ]),
  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://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "data": {
    "id": "<string>",
    "serviceType": "<string>",
    "serviceInstanceId": "<string>",
    "serviceChannelId": "<string>",
    "serviceChannelName": "<string>",
    "mode": "CONNECTED_SERVICE_MODE_UNSPECIFIED"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id

string

required

id

string

required

Serval connection UUID returned by ListConnectedChannels, not the platform channel ID.

Body

application/json

mode

enum<string>

required

Available options:

CONNECTED_SERVICE_MODE_UNSPECIFIED,

CONNECTED_SERVICE_MODE_DISABLED,

CONNECTED_SERVICE_MODE_TICKET_ONLY,

CONNECTED_SERVICE_MODE_SILENT_ASSIST,

CONNECTED_SERVICE_MODE_FULL_ASSIST,

CONNECTED_SERVICE_MODE_TEAM_ONLY,

CONNECTED_SERVICE_MODE_DM,

CONNECTED_SERVICE_MODE_TEAM_INBOX,

CONNECTED_SERVICE_MODE_TEAM_INBOX_ALL,

CONNECTED_SERVICE_MODE_ON_DEMAND,

CONNECTED_SERVICE_MODE_ASSISTANT,

CONNECTED_SERVICE_MODE_REDIRECT_TO_DM

Response

200 - application/json

Success

data

data · object

Show child attributes

Set Connected Channel Mode

curl --request PUT \
  --url https://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode', 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://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode",
  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([
    
  ]),
  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://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/teams/{team_id}/connected-channels/{id}/mode")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "data": {
    "id": "<string>",
    "serviceType": "<string>",
    "serviceInstanceId": "<string>",
    "serviceChannelId": "<string>",
    "serviceChannelName": "<string>",
    "mode": "CONNECTED_SERVICE_MODE_UNSPECIFIED"
  }
}