Rename a connection and/or set its BYO voice CPS rate (slug stays immutable)
PATCH
/
v1
/
integrations
/
connections
/
{connection_id}
Rename a connection and/or set its BYO voice CPS rate (slug stays immutable)
curl --request PATCH \
--url https://api-sandbox.featherhq.com/v1/integrations/connections/{connection_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"nickname": "<string>",
"voice_account_cps": 5000
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/integrations/connections/{connection_id}"
payload = {
"nickname": "<string>",
"voice_account_cps": 5000
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({nickname: '<string>', voice_account_cps: 5000})
};
fetch('https://api-sandbox.featherhq.com/v1/integrations/connections/{connection_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-sandbox.featherhq.com/v1/integrations/connections/{connection_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([
'nickname' => '<string>',
'voice_account_cps' => 5000
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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-sandbox.featherhq.com/v1/integrations/connections/{connection_id}"
payload := strings.NewReader("{\n \"nickname\": \"<string>\",\n \"voice_account_cps\": 5000\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-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.patch("https://api-sandbox.featherhq.com/v1/integrations/connections/{connection_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"nickname\": \"<string>\",\n \"voice_account_cps\": 5000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/integrations/connections/{connection_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"nickname\": \"<string>\",\n \"voice_account_cps\": 5000\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_key": "slack",
"nickname_slug": "<string>",
"nickname": "<string>",
"vendor": "<string>",
"vendor_connection_id": "<string>",
"status": "<string>",
"tools_status": "<string>",
"tools_synced_at": "2023-11-07T05:31:56Z",
"status_reason": "<string>",
"connected_at": "2023-11-07T05:31:56Z",
"last_refreshed_at": "2023-11-07T05:31:56Z",
"last_used_at": "2023-11-07T05:31:56Z",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"voice_account_cps": 123,
"tools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_key": "slack",
"nickname_slug": "<string>",
"tool_path": "<string>",
"slug": "<string>",
"display_name": "<string>",
"description": "<string>",
"input_schema": {},
"is_enabled": true,
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"stale_field_paths": [
"<string>"
],
"default_count": 123,
"pinned_count": 123,
"stale_input_fields": [
"<string>"
],
"merged_input_preview": {},
"response_schema": {},
"response_field_map": {},
"input_defaults": {}
}
]
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
Body
application/json
Response
Successful Response
Stable identifier for each supported integration.
The string value must match the vendor's per-provider identifier
(for Nango: provider_config_key). Persisted on
integration_connections.integration_key and
integration_connection_tools.integration_key.
Adding a new integration: append a member here, add an
IntegrationSpec to INTEGRATIONS, register the provider in the
vendor cloud via src/integrations/bootstrap.py (Step 3).
Available options:
slack, custom_mcp, notion, google_drive, calcom, twilio, email Show child attributes
Show child attributes
Was this page helpful?
⌘I
Rename a connection and/or set its BYO voice CPS rate (slug stays immutable)
curl --request PATCH \
--url https://api-sandbox.featherhq.com/v1/integrations/connections/{connection_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"nickname": "<string>",
"voice_account_cps": 5000
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/integrations/connections/{connection_id}"
payload = {
"nickname": "<string>",
"voice_account_cps": 5000
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({nickname: '<string>', voice_account_cps: 5000})
};
fetch('https://api-sandbox.featherhq.com/v1/integrations/connections/{connection_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-sandbox.featherhq.com/v1/integrations/connections/{connection_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([
'nickname' => '<string>',
'voice_account_cps' => 5000
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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-sandbox.featherhq.com/v1/integrations/connections/{connection_id}"
payload := strings.NewReader("{\n \"nickname\": \"<string>\",\n \"voice_account_cps\": 5000\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-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.patch("https://api-sandbox.featherhq.com/v1/integrations/connections/{connection_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"nickname\": \"<string>\",\n \"voice_account_cps\": 5000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/integrations/connections/{connection_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"nickname\": \"<string>\",\n \"voice_account_cps\": 5000\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_key": "slack",
"nickname_slug": "<string>",
"nickname": "<string>",
"vendor": "<string>",
"vendor_connection_id": "<string>",
"status": "<string>",
"tools_status": "<string>",
"tools_synced_at": "2023-11-07T05:31:56Z",
"status_reason": "<string>",
"connected_at": "2023-11-07T05:31:56Z",
"last_refreshed_at": "2023-11-07T05:31:56Z",
"last_used_at": "2023-11-07T05:31:56Z",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"voice_account_cps": 123,
"tools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_key": "slack",
"nickname_slug": "<string>",
"tool_path": "<string>",
"slug": "<string>",
"display_name": "<string>",
"description": "<string>",
"input_schema": {},
"is_enabled": true,
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"stale_field_paths": [
"<string>"
],
"default_count": 123,
"pinned_count": 123,
"stale_input_fields": [
"<string>"
],
"merged_input_preview": {},
"response_schema": {},
"response_field_map": {},
"input_defaults": {}
}
]
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}