Skip to main content
PATCH
/
api
/
v1
/
organization
Update organization settings
curl --request PATCH \
  --url https://prod.featherhq.com/api/v1/organization \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "allowedChatDomains": [
    "<string>"
  ],
  "toolFailureSlackWebhookUrl": "<string>",
  "schedulerBatchSize": 1,
  "priorityDateBucketConfig": {
    "buckets": [
      {
        "minDays": 1,
        "maxDays": 1,
        "percentage": 50
      }
    ],
    "enabled": true
  }
}
'
import requests

url = "https://prod.featherhq.com/api/v1/organization"

payload = {
"name": "<string>",
"allowedChatDomains": ["<string>"],
"toolFailureSlackWebhookUrl": "<string>",
"schedulerBatchSize": 1,
"priorityDateBucketConfig": {
"buckets": [
{
"minDays": 1,
"maxDays": 1,
"percentage": 50
}
],
"enabled": True
}
}
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({
name: '<string>',
allowedChatDomains: ['<string>'],
toolFailureSlackWebhookUrl: '<string>',
schedulerBatchSize: 1,
priorityDateBucketConfig: {buckets: [{minDays: 1, maxDays: 1, percentage: 50}], enabled: true}
})
};

fetch('https://prod.featherhq.com/api/v1/organization', 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/organization",
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([
'name' => '<string>',
'allowedChatDomains' => [
'<string>'
],
'toolFailureSlackWebhookUrl' => '<string>',
'schedulerBatchSize' => 1,
'priorityDateBucketConfig' => [
'buckets' => [
[
'minDays' => 1,
'maxDays' => 1,
'percentage' => 50
]
],
'enabled' => true
]
]),
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/organization"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"allowedChatDomains\": [\n \"<string>\"\n ],\n \"toolFailureSlackWebhookUrl\": \"<string>\",\n \"schedulerBatchSize\": 1,\n \"priorityDateBucketConfig\": {\n \"buckets\": [\n {\n \"minDays\": 1,\n \"maxDays\": 1,\n \"percentage\": 50\n }\n ],\n \"enabled\": true\n }\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/organization")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"allowedChatDomains\": [\n \"<string>\"\n ],\n \"toolFailureSlackWebhookUrl\": \"<string>\",\n \"schedulerBatchSize\": 1,\n \"priorityDateBucketConfig\": {\n \"buckets\": [\n {\n \"minDays\": 1,\n \"maxDays\": 1,\n \"percentage\": 50\n }\n ],\n \"enabled\": true\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://prod.featherhq.com/api/v1/organization")

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 \"name\": \"<string>\",\n \"allowedChatDomains\": [\n \"<string>\"\n ],\n \"toolFailureSlackWebhookUrl\": \"<string>\",\n \"schedulerBatchSize\": 1,\n \"priorityDateBucketConfig\": {\n \"buckets\": [\n {\n \"minDays\": 1,\n \"maxDays\": 1,\n \"percentage\": 50\n }\n ],\n \"enabled\": true\n }\n}"

response = http.request(request)
puts response.read_body
{
  "organization": {
    "id": "<string>",
    "name": "<string>",
    "allowedChatDomains": [
      "<string>"
    ],
    "toolFailureSlackWebhookConfigured": true,
    "toolFailureSlackConnected": true,
    "toolFailureSlackChannelConfigured": true,
    "schedulerBatchSize": 123,
    "maxSchedulerBatchSize": 123,
    "priorityDateBucketConfig": {
      "buckets": [
        {
          "minDays": 1,
          "maxDays": 1,
          "percentage": 50
        }
      ],
      "enabled": true
    },
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}
{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
Required string length: 1 - 255
allowedChatDomains
string[]
Maximum array length: 50
Pattern: ^(\*\.)?([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)*[a-zA-Z]{2,}$|^localhost$
toolFailureSlackWebhookUrl
string<uri> | null
schedulerBatchSize
integer
Required range: x >= 0
priorityDateBucketConfig
object | null

Response

Organization updated successfully

organization
object
required