curl --request PATCH \
--url https://app.famulor.io/api/v1/custom-domain/link-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"link_preview_title": "Acme Voice – your appointment assistant",
"link_preview_description": "Book, move or cancel appointments around the clock."
}
'import requests
url = "https://app.famulor.io/api/v1/custom-domain/link-preview"
payload = {
"link_preview_title": "Acme Voice – your appointment assistant",
"link_preview_description": "Book, move or cancel appointments around the clock."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
link_preview_title: 'Acme Voice – your appointment assistant',
link_preview_description: 'Book, move or cancel appointments around the clock.'
})
};
fetch('https://app.famulor.io/api/v1/custom-domain/link-preview', 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://app.famulor.io/api/v1/custom-domain/link-preview",
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([
'link_preview_title' => 'Acme Voice – your appointment assistant',
'link_preview_description' => 'Book, move or cancel appointments around the clock.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.famulor.io/api/v1/custom-domain/link-preview"
payload := strings.NewReader("{\n \"link_preview_title\": \"Acme Voice – your appointment assistant\",\n \"link_preview_description\": \"Book, move or cancel appointments around the clock.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.famulor.io/api/v1/custom-domain/link-preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"link_preview_title\": \"Acme Voice – your appointment assistant\",\n \"link_preview_description\": \"Book, move or cancel appointments around the clock.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/custom-domain/link-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"link_preview_title\": \"Acme Voice – your appointment assistant\",\n \"link_preview_description\": \"Book, move or cancel appointments around the clock.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"link_preview_title": "Acme Voice – your appointment assistant",
"link_preview_description": "Book, move or cancel appointments around the clock.",
"effective_title": "Acme Voice – your appointment assistant",
"effective_description": "Book, move or cancel appointments around the clock.",
"custom_domain": "app.acme-voice.com",
"custom_domain_verified": true
}
}Update custom domain link preview
Sets the title and/or description that link previews and the browser tab show for the white-label custom domain. Only the fields you send change. null or an empty string resets a field: the title then shows the app name, the description is left out. Line breaks are folded into spaces. Messengers keep old previews cached for a while. Required scope: settings:write or assistants:write. Requires the white-label entitlement (plan add-on whitelabel, or a workspace override). Workspaces without it get 403 whitelabel_not_in_plan, and only workspace owners and admins may call it.
curl --request PATCH \
--url https://app.famulor.io/api/v1/custom-domain/link-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"link_preview_title": "Acme Voice – your appointment assistant",
"link_preview_description": "Book, move or cancel appointments around the clock."
}
'import requests
url = "https://app.famulor.io/api/v1/custom-domain/link-preview"
payload = {
"link_preview_title": "Acme Voice – your appointment assistant",
"link_preview_description": "Book, move or cancel appointments around the clock."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
link_preview_title: 'Acme Voice – your appointment assistant',
link_preview_description: 'Book, move or cancel appointments around the clock.'
})
};
fetch('https://app.famulor.io/api/v1/custom-domain/link-preview', 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://app.famulor.io/api/v1/custom-domain/link-preview",
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([
'link_preview_title' => 'Acme Voice – your appointment assistant',
'link_preview_description' => 'Book, move or cancel appointments around the clock.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.famulor.io/api/v1/custom-domain/link-preview"
payload := strings.NewReader("{\n \"link_preview_title\": \"Acme Voice – your appointment assistant\",\n \"link_preview_description\": \"Book, move or cancel appointments around the clock.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.famulor.io/api/v1/custom-domain/link-preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"link_preview_title\": \"Acme Voice – your appointment assistant\",\n \"link_preview_description\": \"Book, move or cancel appointments around the clock.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/custom-domain/link-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"link_preview_title\": \"Acme Voice – your appointment assistant\",\n \"link_preview_description\": \"Book, move or cancel appointments around the clock.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"link_preview_title": "Acme Voice – your appointment assistant",
"link_preview_description": "Book, move or cancel appointments around the clock.",
"effective_title": "Acme Voice – your appointment assistant",
"effective_description": "Book, move or cancel appointments around the clock.",
"custom_domain": "app.acme-voice.com",
"custom_domain_verified": true
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.