List campaign templates
curl --request GET \
--url https://app.famulor.io/api/v1/campaign-templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/campaign-templates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/campaign-templates', 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/campaign-templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.famulor.io/api/v1/campaign-templates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.famulor.io/api/v1/campaign-templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/campaign-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "appointment_reminder",
"category": "appointments",
"category_label": "Appointments",
"name": "Appointment reminder",
"description": "Reminds by text and calls only the contacts who do not confirm, to confirm or reschedule.",
"featured": true,
"channels": [
"sms",
"phone_call"
],
"step_count": 2,
"needs_sender": true,
"sequence": {
"version": 1,
"start_node_id": "reminder_text",
"nodes": [
{
"id": "reminder_text",
"name": "Reminder text",
"channel": "sms",
"assistant_id": null,
"message": {
"config": {
"from_number_id": "",
"message": "Hi {{first_name}}, this is a reminder of your upcoming appointment with us. Reply YES to confirm or call us to reschedule.",
"variable_mapping": {}
},
"wait_minutes": 1440,
"next": {
"type": "node",
"node_id": "confirmation_call"
},
"failed": {
"type": "end",
"successful": false
},
"replied": {
"type": "end",
"successful": true
}
}
},
{
"id": "confirmation_call",
"name": "Confirmation call",
"assistant_id": null,
"attempts": [
{
"delay_minutes": 0
},
{
"delay_minutes": 120
}
],
"outcomes": [
{
"id": "confirmed",
"label": "Confirmed",
"condition": {
"type": "prompt",
"description": "The contact confirms they will attend the appointment."
},
"destination": {
"type": "end",
"successful": true
}
},
{
"id": "rescheduled",
"label": "Rescheduled",
"condition": {
"type": "prompt",
"description": "The contact agrees on a new date or time for the appointment."
},
"destination": {
"type": "end",
"successful": true
}
},
{
"id": "cancelled",
"label": "Cancelled",
"condition": {
"type": "prompt",
"description": "The contact cancels the appointment and does not want a new one."
},
"destination": {
"type": "end",
"successful": false
}
}
],
"no_response": {
"destination": {
"type": "end",
"successful": false
}
},
"other": {
"destination": {
"type": "end",
"successful": false
}
}
}
],
"global_outcomes": []
}
}
]
}Campaigns
List campaign templates
Ready-made campaign sequences from the template gallery of the web app: call steps and SMS & RCS, WhatsApp template and email steps with their outcomes, waits and texts, in the requested language. To use one, send its sequence as sequence with createCampaign or updateCampaign, after you changed what you need. When needs_sender is true, set the sender first: from_number_id (or rcs_sender_id) on each sms step and connector_id plus template_id on each whatsapp_template step; until then the campaign is rejected. Call steps use the campaign assistant (assistant_id is null), and email steps send from that assistant’s verified address. Featured templates come first. Required scope: campaigns:read.
GET
/
campaign-templates
List campaign templates
curl --request GET \
--url https://app.famulor.io/api/v1/campaign-templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/campaign-templates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/campaign-templates', 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/campaign-templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.famulor.io/api/v1/campaign-templates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.famulor.io/api/v1/campaign-templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/campaign-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "appointment_reminder",
"category": "appointments",
"category_label": "Appointments",
"name": "Appointment reminder",
"description": "Reminds by text and calls only the contacts who do not confirm, to confirm or reschedule.",
"featured": true,
"channels": [
"sms",
"phone_call"
],
"step_count": 2,
"needs_sender": true,
"sequence": {
"version": 1,
"start_node_id": "reminder_text",
"nodes": [
{
"id": "reminder_text",
"name": "Reminder text",
"channel": "sms",
"assistant_id": null,
"message": {
"config": {
"from_number_id": "",
"message": "Hi {{first_name}}, this is a reminder of your upcoming appointment with us. Reply YES to confirm or call us to reschedule.",
"variable_mapping": {}
},
"wait_minutes": 1440,
"next": {
"type": "node",
"node_id": "confirmation_call"
},
"failed": {
"type": "end",
"successful": false
},
"replied": {
"type": "end",
"successful": true
}
}
},
{
"id": "confirmation_call",
"name": "Confirmation call",
"assistant_id": null,
"attempts": [
{
"delay_minutes": 0
},
{
"delay_minutes": 120
}
],
"outcomes": [
{
"id": "confirmed",
"label": "Confirmed",
"condition": {
"type": "prompt",
"description": "The contact confirms they will attend the appointment."
},
"destination": {
"type": "end",
"successful": true
}
},
{
"id": "rescheduled",
"label": "Rescheduled",
"condition": {
"type": "prompt",
"description": "The contact agrees on a new date or time for the appointment."
},
"destination": {
"type": "end",
"successful": true
}
},
{
"id": "cancelled",
"label": "Cancelled",
"condition": {
"type": "prompt",
"description": "The contact cancels the appointment and does not want a new one."
},
"destination": {
"type": "end",
"successful": false
}
}
],
"no_response": {
"destination": {
"type": "end",
"successful": false
}
},
"other": {
"destination": {
"type": "end",
"successful": false
}
}
}
],
"global_outcomes": []
}
}
]
}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.
Query Parameters
Language of the template names, descriptions, step names, outcome labels and message texts. The server answers in English for any other value.
Available options:
en, de, fr, es Only templates of this category.
Available options:
basics, sales, appointments, service, billing, events Response
Campaign templates.
Show child attributes
Show child attributes