API Reference
Assistants
- GETList assistants
- GETGet outbound assistants
- POSTCreate assistant
- PUTUpdate assistant
- DELDelete assistant
- POSTEnable assistant inbound webhook
- POSTDisable assistant inbound webhook
- POSTDisable assistant webhook
- GETGet available languages
- GETGet available voices
- GETGet available LLM models
- GETGet available phone numbers
Mid Call Tools
Campaigns
SMS
Webhooks
Create lead
Copy
curl --request POST \
--url https://app.famulor.de/api/user/lead \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone_number": "<string>",
"campaign_id": 123,
"variables": {
"customer_name": "<string>",
"email": "<string>"
},
"allow_dupplicate": true,
"secondary_contacts": [
{
"phone_number": "<string>",
"variables": {
"customer_name": "<string>",
"email": "<string>"
}
}
]
}
'Copy
{
"message": "Lead created successfully",
"data": {
"id": 1,
"campaign_id": 1,
"phone_number": "+1234567890",
"variables": {
"customer_name": "John Doe",
"email": "[email protected]"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20",
"campaign": {
"id": 1,
"name": "My new campaign"
},
"secondary_contacts": [
{
"id": 2,
"phone_number": "+1234567891",
"variables": {
"customer_name": "Jane Doe Secondary",
"email": "[email protected]"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20"
},
{
"id": 3,
"phone_number": "+1234567892",
"variables": {
"customer_name": "Bob Doe Office",
"email": "[email protected]"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20"
}
]
}
}
Leads
Create lead
Add a new lead to your campaign
POST
https://app.famulor.de/api/
/
user
/
lead
Create lead
Copy
curl --request POST \
--url https://app.famulor.de/api/user/lead \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone_number": "<string>",
"campaign_id": 123,
"variables": {
"customer_name": "<string>",
"email": "<string>"
},
"allow_dupplicate": true,
"secondary_contacts": [
{
"phone_number": "<string>",
"variables": {
"customer_name": "<string>",
"email": "<string>"
}
}
]
}
'Copy
{
"message": "Lead created successfully",
"data": {
"id": 1,
"campaign_id": 1,
"phone_number": "+1234567890",
"variables": {
"customer_name": "John Doe",
"email": "[email protected]"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20",
"campaign": {
"id": 1,
"name": "My new campaign"
},
"secondary_contacts": [
{
"id": 2,
"phone_number": "+1234567891",
"variables": {
"customer_name": "Jane Doe Secondary",
"email": "[email protected]"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20"
},
{
"id": 3,
"phone_number": "+1234567892",
"variables": {
"customer_name": "Bob Doe Office",
"email": "[email protected]"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20"
}
]
}
}
Use this endpoint to add a new lead entry to one of your campaigns. Leads represent potential customers that your assistants will call.
Request Body
Contact phone number in E.164 format (example: +1234567890)
The campaign ID where this lead should be added
Permit creating duplicate leads within the same campaign (default: false)
Additional contact persons linked to this lead
Show secondary_contacts properties
Show secondary_contacts properties
Response
Success confirmation message
The created lead object with all associated data
Show data properties
Show data properties
Unique identifier for the new lead
Campaign identifier this lead is assigned to
Lead’s contact number in E.164 format
Current lead status
Creation timestamp
Last modification timestamp
List of secondary contacts created with this lead
Show secondary_contacts properties
Show secondary_contacts properties
Secondary contact identifier
Secondary contact phone number in E.164 format
Variables for the secondary contact
Secondary contact status
Secondary contact creation timestamp
Secondary contact last update timestamp
Copy
{
"message": "Lead created successfully",
"data": {
"id": 1,
"campaign_id": 1,
"phone_number": "+1234567890",
"variables": {
"customer_name": "John Doe",
"email": "[email protected]"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20",
"campaign": {
"id": 1,
"name": "My new campaign"
},
"secondary_contacts": [
{
"id": 2,
"phone_number": "+1234567891",
"variables": {
"customer_name": "Jane Doe Secondary",
"email": "[email protected]"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20"
},
{
"id": 3,
"phone_number": "+1234567892",
"variables": {
"customer_name": "Bob Doe Office",
"email": "[email protected]"
},
"status": "created",
"created_at": "2025-06-30 11:53:20",
"updated_at": "2025-06-30 11:53:20"
}
]
}
}
⌘I