curl --request POST \
--url https://app.famulor.io/api/v1/leads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "+491701234567",
"name": "Ada Lovelace",
"email": "ada@example.com",
"tags": [
"vip",
"renewal"
]
}
'import requests
url = "https://app.famulor.io/api/v1/leads"
payload = {
"phone": "+491701234567",
"name": "Ada Lovelace",
"email": "ada@example.com",
"tags": ["vip", "renewal"]
}
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({
phone: '+491701234567',
name: 'Ada Lovelace',
email: 'ada@example.com',
tags: ['vip', 'renewal']
})
};
fetch('https://app.famulor.io/api/v1/leads', 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/leads",
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([
'phone' => '+491701234567',
'name' => 'Ada Lovelace',
'email' => 'ada@example.com',
'tags' => [
'vip',
'renewal'
]
]),
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/leads"
payload := strings.NewReader("{\n \"phone\": \"+491701234567\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"tags\": [\n \"vip\",\n \"renewal\"\n ]\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/leads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"+491701234567\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"tags\": [\n \"vip\",\n \"renewal\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/leads")
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 \"phone\": \"+491701234567\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"tags\": [\n \"vip\",\n \"renewal\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": false
}
}Create an Audience contact
Create an unassigned Audience contact, or merge user-defined tags and missing identity fields into an existing contact with the same phone or email. Required scope: leads:write (legacy calls:write is also accepted).
curl --request POST \
--url https://app.famulor.io/api/v1/leads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "+491701234567",
"name": "Ada Lovelace",
"email": "ada@example.com",
"tags": [
"vip",
"renewal"
]
}
'import requests
url = "https://app.famulor.io/api/v1/leads"
payload = {
"phone": "+491701234567",
"name": "Ada Lovelace",
"email": "ada@example.com",
"tags": ["vip", "renewal"]
}
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({
phone: '+491701234567',
name: 'Ada Lovelace',
email: 'ada@example.com',
tags: ['vip', 'renewal']
})
};
fetch('https://app.famulor.io/api/v1/leads', 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/leads",
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([
'phone' => '+491701234567',
'name' => 'Ada Lovelace',
'email' => 'ada@example.com',
'tags' => [
'vip',
'renewal'
]
]),
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/leads"
payload := strings.NewReader("{\n \"phone\": \"+491701234567\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"tags\": [\n \"vip\",\n \"renewal\"\n ]\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/leads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"+491701234567\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"tags\": [\n \"vip\",\n \"renewal\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/leads")
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 \"phone\": \"+491701234567\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"tags\": [\n \"vip\",\n \"renewal\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": false
}
}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.
Body
Response
The request matched and enriched an existing contact.
Show child attributes
Show child attributes