Set/clear the org's HITL approval-UX lines
PUT
/
v1
/
hitl
/
approval-messages
Set/clear the org's HITL approval-UX lines
curl --request PUT \
--url https://api-sandbox.featherhq.com/v1/hitl/approval-messages \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"holding_line": "<string>",
"waiting_reply": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/hitl/approval-messages"
payload = {
"holding_line": "<string>",
"waiting_reply": "<string>"
}
headers = {
"x-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-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({holding_line: '<string>', waiting_reply: '<string>'})
};
fetch('https://api-sandbox.featherhq.com/v1/hitl/approval-messages', 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/hitl/approval-messages",
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([
'holding_line' => '<string>',
'waiting_reply' => '<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://api-sandbox.featherhq.com/v1/hitl/approval-messages"
payload := strings.NewReader("{\n \"holding_line\": \"<string>\",\n \"waiting_reply\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api-sandbox.featherhq.com/v1/hitl/approval-messages")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"holding_line\": \"<string>\",\n \"waiting_reply\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/hitl/approval-messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"holding_line\": \"<string>\",\n \"waiting_reply\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"holding_line": "<string>",
"waiting_reply": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
application/json
Set or clear the org's two HITL approval-UX lines (full-replace, PUT semantics).
Both fields are REQUIRED but nullable, so a full-replace can't silently wipe a line by
omission: a non-blank string SETS that line; null (or blank) CLEARS it back to the code
default; an OMITTED field is a 422 (send the complete desired state, both keys present).
Response
Successful Response
The org's two HITL approval-UX lines, RESOLVED (org value or code default).
Both are always concrete strings: when the org hasn't configured a line, the resolved
code default is surfaced so the UI shows exactly what an end-user will see. To revert a
line to its default, PUT null for that field.
Was this page helpful?
⌘I
Set/clear the org's HITL approval-UX lines
curl --request PUT \
--url https://api-sandbox.featherhq.com/v1/hitl/approval-messages \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"holding_line": "<string>",
"waiting_reply": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/hitl/approval-messages"
payload = {
"holding_line": "<string>",
"waiting_reply": "<string>"
}
headers = {
"x-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-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({holding_line: '<string>', waiting_reply: '<string>'})
};
fetch('https://api-sandbox.featherhq.com/v1/hitl/approval-messages', 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/hitl/approval-messages",
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([
'holding_line' => '<string>',
'waiting_reply' => '<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://api-sandbox.featherhq.com/v1/hitl/approval-messages"
payload := strings.NewReader("{\n \"holding_line\": \"<string>\",\n \"waiting_reply\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api-sandbox.featherhq.com/v1/hitl/approval-messages")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"holding_line\": \"<string>\",\n \"waiting_reply\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/hitl/approval-messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"holding_line\": \"<string>\",\n \"waiting_reply\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"holding_line": "<string>",
"waiting_reply": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}