Skip to main content
PUT
/
organization
/
chat
Update chat widget configuration
curl --request PUT \
  --url https://api.getfernand.com/organization/chat \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "channel": 12345
}
'
import requests

url = "https://api.getfernand.com/organization/chat"

payload = { "channel": 12345 }
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({channel: 12345})
};

fetch('https://api.getfernand.com/organization/chat', 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.getfernand.com/organization/chat",
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([
'channel' => 12345
]),
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;
}
require 'uri'
require 'net/http'

url = URI("https://api.getfernand.com/organization/chat")

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 \"channel\": 12345\n}"

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

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.getfernand.com/organization/chat"

payload := strings.NewReader("{\n \"channel\": 12345\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))

}
using RestSharp;


var options = new RestClientOptions("https://api.getfernand.com/organization/chat");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
request.AddJsonBody("{\n \"channel\": 12345\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.put("https://api.getfernand.com/organization/chat")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": 12345\n}")
.asString();
{
  "secret": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
  "settings": {
    "channel": 12345,
    "domains": [
      "piedpiper.com",
      "piedpiper.dev",
      "piedpiper.xyz"
    ]
  }
}
{
"error": "<string>"
}
Updates the organization’s chat widget settings. The channel property must be a valid channel ID belonging to the organization.

Authorizations

X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Body

application/json
channel
integer
required

Default channel ID for chat conversations (required).

Example:

12345

domains
string

Comma-separated list of allowed domains for chat widget (optional).

Example:

"piedpiper.com,piedpiper.dev,piedpiper.xyz"

Response

Chat configuration updated successfully.

secret
string

Secure key for HMAC authentication of chat widget.

Example:

"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0"

settings
object

Chat widget settings.