curl --request PATCH \
--url https://app.famulor.io/api/v1/crm-syncs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"object_type": "<string>",
"selection": {},
"field_mapping": {},
"interval_minutes": 5070,
"outbound_create": true
}
'import requests
url = "https://app.famulor.io/api/v1/crm-syncs/{id}"
payload = {
"name": "<string>",
"object_type": "<string>",
"selection": {},
"field_mapping": {},
"interval_minutes": 5070,
"outbound_create": True
}
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({
name: '<string>',
object_type: '<string>',
selection: {},
field_mapping: {},
interval_minutes: 5070,
outbound_create: true
})
};
fetch('https://app.famulor.io/api/v1/crm-syncs/{id}', 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/crm-syncs/{id}",
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>',
'object_type' => '<string>',
'selection' => [
],
'field_mapping' => [
],
'interval_minutes' => 5070,
'outbound_create' => true
]),
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/crm-syncs/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"selection\": {},\n \"field_mapping\": {},\n \"interval_minutes\": 5070,\n \"outbound_create\": true\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/crm-syncs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"selection\": {},\n \"field_mapping\": {},\n \"interval_minutes\": 5070,\n \"outbound_create\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/crm-syncs/{id}")
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 \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"selection\": {},\n \"field_mapping\": {},\n \"interval_minutes\": 5070,\n \"outbound_create\": true\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"error": {
"code": "not_found",
"message": "Assistant not found"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Update CRM sync
Patch source selection, field mapping, interval, direction, outbound create, policies, or active/paused status. Mapping and source changes reset the cursor but keep the existing schedule; use POST /crm-syncs//runs to sync immediately. Requires automations:write or calls:write.
curl --request PATCH \
--url https://app.famulor.io/api/v1/crm-syncs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"object_type": "<string>",
"selection": {},
"field_mapping": {},
"interval_minutes": 5070,
"outbound_create": true
}
'import requests
url = "https://app.famulor.io/api/v1/crm-syncs/{id}"
payload = {
"name": "<string>",
"object_type": "<string>",
"selection": {},
"field_mapping": {},
"interval_minutes": 5070,
"outbound_create": True
}
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({
name: '<string>',
object_type: '<string>',
selection: {},
field_mapping: {},
interval_minutes: 5070,
outbound_create: true
})
};
fetch('https://app.famulor.io/api/v1/crm-syncs/{id}', 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/crm-syncs/{id}",
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>',
'object_type' => '<string>',
'selection' => [
],
'field_mapping' => [
],
'interval_minutes' => 5070,
'outbound_create' => true
]),
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/crm-syncs/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"selection\": {},\n \"field_mapping\": {},\n \"interval_minutes\": 5070,\n \"outbound_create\": true\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/crm-syncs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"selection\": {},\n \"field_mapping\": {},\n \"interval_minutes\": 5070,\n \"outbound_create\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/crm-syncs/{id}")
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 \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"selection\": {},\n \"field_mapping\": {},\n \"interval_minutes\": 5070,\n \"outbound_create\": true\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"error": {
"code": "not_found",
"message": "Assistant not found"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}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.
Path Parameters
CRM sync ID.
Body
Partial CRM sync update. All fields are optional; the connection is immutable.
1 - 1281 - 128Replacement provider-neutral selection. default_phone_country accepts a supported ISO-2 country code.
Replacement mapping. Bare source keys stay 1:1; composed values use non-evaluated {{field}} tokens and optional literal text. Destinations include channel identities such as channel.telegram.username or channel.whatsapp.user_id. At least one target must be phone or email, and each target appears once.
Show child attributes
Show child attributes
60 <= x <= 10080active, paused ignore, clear deactivate_membership, keep review, skip inbound, outbound, bidirectional Response
Updated CRM sync.