Update transfer rule
curl --request PATCH \
--url https://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"allowManualTrigger": true,
"toolDescription": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": true
}
],
"speakBeforeTransfer": "<string>"
}
'import requests
url = "https://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}"
payload = {
"allowManualTrigger": True,
"toolDescription": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": True
}
],
"speakBeforeTransfer": "<string>"
}
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({
allowManualTrigger: true,
toolDescription: '<string>',
variables: [{name: '<string>', description: '<string>', required: true}],
speakBeforeTransfer: '<string>'
})
};
fetch('https://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}', 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://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}",
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([
'allowManualTrigger' => true,
'toolDescription' => '<string>',
'variables' => [
[
'name' => '<string>',
'description' => '<string>',
'required' => true
]
],
'speakBeforeTransfer' => '<string>'
]),
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://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}"
payload := strings.NewReader("{\n \"allowManualTrigger\": true,\n \"toolDescription\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"speakBeforeTransfer\": \"<string>\"\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://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"allowManualTrigger\": true,\n \"toolDescription\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"speakBeforeTransfer\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}")
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 \"allowManualTrigger\": true,\n \"toolDescription\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"speakBeforeTransfer\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"transferRule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"squadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allowManualTrigger": true,
"toolDescription": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": true
}
],
"speakBeforeTransfer": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"fromAgent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"toAgent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
}{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}{
"status": 404,
"message": "Not found",
"code": "NOT_FOUND",
"success": false
}{
"status": 500,
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"success": false
}Squad
Update transfer rule
Update an existing transfer rule
PATCH
/
api
/
v1
/
squads
/
{squadId}
/
transfer-rules
/
{ruleId}
Update transfer rule
curl --request PATCH \
--url https://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"allowManualTrigger": true,
"toolDescription": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": true
}
],
"speakBeforeTransfer": "<string>"
}
'import requests
url = "https://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}"
payload = {
"allowManualTrigger": True,
"toolDescription": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": True
}
],
"speakBeforeTransfer": "<string>"
}
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({
allowManualTrigger: true,
toolDescription: '<string>',
variables: [{name: '<string>', description: '<string>', required: true}],
speakBeforeTransfer: '<string>'
})
};
fetch('https://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}', 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://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}",
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([
'allowManualTrigger' => true,
'toolDescription' => '<string>',
'variables' => [
[
'name' => '<string>',
'description' => '<string>',
'required' => true
]
],
'speakBeforeTransfer' => '<string>'
]),
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://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}"
payload := strings.NewReader("{\n \"allowManualTrigger\": true,\n \"toolDescription\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"speakBeforeTransfer\": \"<string>\"\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://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"allowManualTrigger\": true,\n \"toolDescription\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"speakBeforeTransfer\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules/{ruleId}")
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 \"allowManualTrigger\": true,\n \"toolDescription\": \"<string>\",\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true\n }\n ],\n \"speakBeforeTransfer\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"transferRule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"squadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allowManualTrigger": true,
"toolDescription": "<string>",
"variables": [
{
"name": "<string>",
"description": "<string>",
"required": true
}
],
"speakBeforeTransfer": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"fromAgent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"toAgent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
}{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}{
"status": 404,
"message": "Not found",
"code": "NOT_FOUND",
"success": false
}{
"status": 500,
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"success": false
}Authorizations
Body
application/json
Response
Transfer rule updated successfully
Show child attributes
Show child attributes
⌘I