curl --request POST \
--url https://app.famulor.io/api/v1/crm-syncs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"object_type": "<string>",
"field_mapping": {
"{{salutation}} {{firstName}} {{lastName}}": "name",
"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}": "phone",
"email": "email"
},
"selection": {},
"interval_minutes": 60,
"null_policy": "ignore",
"removal_policy": "deactivate_membership",
"conflict_policy": "review",
"direction": "inbound",
"outbound_create": false
}
'import requests
url = "https://app.famulor.io/api/v1/crm-syncs"
payload = {
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"object_type": "<string>",
"field_mapping": {
"{{salutation}} {{firstName}} {{lastName}}": "name",
"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}": "phone",
"email": "email"
},
"selection": {},
"interval_minutes": 60,
"null_policy": "ignore",
"removal_policy": "deactivate_membership",
"conflict_policy": "review",
"direction": "inbound",
"outbound_create": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
object_type: '<string>',
field_mapping: {
'{{salutation}} {{firstName}} {{lastName}}': 'name',
'{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}': 'phone',
email: 'email'
},
selection: {},
interval_minutes: 60,
null_policy: 'ignore',
removal_policy: 'deactivate_membership',
conflict_policy: 'review',
direction: 'inbound',
outbound_create: false
})
};
fetch('https://app.famulor.io/api/v1/crm-syncs', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'object_type' => '<string>',
'field_mapping' => [
'{{salutation}} {{firstName}} {{lastName}}' => 'name',
'{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}' => 'phone',
'email' => 'email'
],
'selection' => [
],
'interval_minutes' => 60,
'null_policy' => 'ignore',
'removal_policy' => 'deactivate_membership',
'conflict_policy' => 'review',
'direction' => 'inbound',
'outbound_create' => false
]),
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"
payload := strings.NewReader("{\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"field_mapping\": {\n \"{{salutation}} {{firstName}} {{lastName}}\": \"name\",\n \"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}\": \"phone\",\n \"email\": \"email\"\n },\n \"selection\": {},\n \"interval_minutes\": 60,\n \"null_policy\": \"ignore\",\n \"removal_policy\": \"deactivate_membership\",\n \"conflict_policy\": \"review\",\n \"direction\": \"inbound\",\n \"outbound_create\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.famulor.io/api/v1/crm-syncs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"field_mapping\": {\n \"{{salutation}} {{firstName}} {{lastName}}\": \"name\",\n \"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}\": \"phone\",\n \"email\": \"email\"\n },\n \"selection\": {},\n \"interval_minutes\": 60,\n \"null_policy\": \"ignore\",\n \"removal_policy\": \"deactivate_membership\",\n \"conflict_policy\": \"review\",\n \"direction\": \"inbound\",\n \"outbound_create\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/crm-syncs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"field_mapping\": {\n \"{{salutation}} {{firstName}} {{lastName}}\": \"name\",\n \"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}\": \"phone\",\n \"email\": \"email\"\n },\n \"selection\": {},\n \"interval_minutes\": 60,\n \"null_policy\": \"ignore\",\n \"removal_policy\": \"deactivate_membership\",\n \"conflict_policy\": \"review\",\n \"direction\": \"inbound\",\n \"outbound_create\": false\n}"
response = http.request(request)
puts response.read_bodyCreate CRM sync
Create a recurring CRM sync using an existing API connection. Direction can import CRM records into Audience, push Audience contacts to the CRM, or both on the same schedule. Combined expressions are import-only; outbound needs a 1:1 phone or email mapping. The provider is resolved from the tenant-scoped connection and cannot be supplied by the caller. Requires automations:write or calls:write.
curl --request POST \
--url https://app.famulor.io/api/v1/crm-syncs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"object_type": "<string>",
"field_mapping": {
"{{salutation}} {{firstName}} {{lastName}}": "name",
"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}": "phone",
"email": "email"
},
"selection": {},
"interval_minutes": 60,
"null_policy": "ignore",
"removal_policy": "deactivate_membership",
"conflict_policy": "review",
"direction": "inbound",
"outbound_create": false
}
'import requests
url = "https://app.famulor.io/api/v1/crm-syncs"
payload = {
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"object_type": "<string>",
"field_mapping": {
"{{salutation}} {{firstName}} {{lastName}}": "name",
"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}": "phone",
"email": "email"
},
"selection": {},
"interval_minutes": 60,
"null_policy": "ignore",
"removal_policy": "deactivate_membership",
"conflict_policy": "review",
"direction": "inbound",
"outbound_create": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
object_type: '<string>',
field_mapping: {
'{{salutation}} {{firstName}} {{lastName}}': 'name',
'{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}': 'phone',
email: 'email'
},
selection: {},
interval_minutes: 60,
null_policy: 'ignore',
removal_policy: 'deactivate_membership',
conflict_policy: 'review',
direction: 'inbound',
outbound_create: false
})
};
fetch('https://app.famulor.io/api/v1/crm-syncs', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'object_type' => '<string>',
'field_mapping' => [
'{{salutation}} {{firstName}} {{lastName}}' => 'name',
'{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}' => 'phone',
'email' => 'email'
],
'selection' => [
],
'interval_minutes' => 60,
'null_policy' => 'ignore',
'removal_policy' => 'deactivate_membership',
'conflict_policy' => 'review',
'direction' => 'inbound',
'outbound_create' => false
]),
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"
payload := strings.NewReader("{\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"field_mapping\": {\n \"{{salutation}} {{firstName}} {{lastName}}\": \"name\",\n \"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}\": \"phone\",\n \"email\": \"email\"\n },\n \"selection\": {},\n \"interval_minutes\": 60,\n \"null_policy\": \"ignore\",\n \"removal_policy\": \"deactivate_membership\",\n \"conflict_policy\": \"review\",\n \"direction\": \"inbound\",\n \"outbound_create\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.famulor.io/api/v1/crm-syncs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"field_mapping\": {\n \"{{salutation}} {{firstName}} {{lastName}}\": \"name\",\n \"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}\": \"phone\",\n \"email\": \"email\"\n },\n \"selection\": {},\n \"interval_minutes\": 60,\n \"null_policy\": \"ignore\",\n \"removal_policy\": \"deactivate_membership\",\n \"conflict_policy\": \"review\",\n \"direction\": \"inbound\",\n \"outbound_create\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/crm-syncs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"object_type\": \"<string>\",\n \"field_mapping\": {\n \"{{salutation}} {{firstName}} {{lastName}}\": \"name\",\n \"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}\": \"phone\",\n \"email\": \"email\"\n },\n \"selection\": {},\n \"interval_minutes\": 60,\n \"null_policy\": \"ignore\",\n \"removal_policy\": \"deactivate_membership\",\n \"conflict_policy\": \"review\",\n \"direction\": \"inbound\",\n \"outbound_create\": false\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
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.
Body
External source to Audience target. A bare key keeps legacy 1:1 behavior. To combine fields or fixed text, use non-evaluated {{field}} tokens in one source expression, for example {{salutation}} {{firstName}} {{lastName}} or +49{{phone}}. 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
{
"{{salutation}} {{firstName}} {{lastName}}": "name",
"{{phones.primaryPhoneCallingCode}}{{phones.primaryPhoneNumber}}": "phone",
"email": "email"
}
Response
Created CRM sync.