Prepare or attach SMS registration
curl --request POST \
--url https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "save",
"details": {
"legal_name": "<string>",
"registration_number": "<string>",
"website": "<string>",
"regions": [],
"stock_exchange": "",
"stock_ticker": "",
"brand_contact_email": "",
"representative_first_name": "<string>",
"representative_last_name": "<string>",
"representative_email": "jsmith@example.com",
"representative_phone": "<string>",
"representative_title": "<string>",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>",
"campaign_description": "<string>",
"message_flow": "<string>",
"message_samples": [
"<string>"
],
"privacy_policy_url": "<string>",
"terms_url": "<string>",
"has_links": true,
"has_phone_numbers": true,
"age_gated": true,
"direct_lending": true,
"consent_confirmed": true
}
}
'import requests
url = "https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration"
payload = {
"action": "save",
"details": {
"legal_name": "<string>",
"registration_number": "<string>",
"website": "<string>",
"regions": [],
"stock_exchange": "",
"stock_ticker": "",
"brand_contact_email": "",
"representative_first_name": "<string>",
"representative_last_name": "<string>",
"representative_email": "jsmith@example.com",
"representative_phone": "<string>",
"representative_title": "<string>",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>",
"campaign_description": "<string>",
"message_flow": "<string>",
"message_samples": ["<string>"],
"privacy_policy_url": "<string>",
"terms_url": "<string>",
"has_links": True,
"has_phone_numbers": True,
"age_gated": True,
"direct_lending": True,
"consent_confirmed": True
}
}
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({
action: 'save',
details: {
legal_name: '<string>',
registration_number: '<string>',
website: '<string>',
regions: [],
stock_exchange: '',
stock_ticker: '',
brand_contact_email: '',
representative_first_name: '<string>',
representative_last_name: '<string>',
representative_email: 'jsmith@example.com',
representative_phone: '<string>',
representative_title: '<string>',
street: '<string>',
city: '<string>',
region: '<string>',
postal_code: '<string>',
country: '<string>',
campaign_description: '<string>',
message_flow: '<string>',
message_samples: ['<string>'],
privacy_policy_url: '<string>',
terms_url: '<string>',
has_links: true,
has_phone_numbers: true,
age_gated: true,
direct_lending: true,
consent_confirmed: true
}
})
};
fetch('https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration', 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/phone-numbers/{id}/sms-registration",
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([
'action' => 'save',
'details' => [
'legal_name' => '<string>',
'registration_number' => '<string>',
'website' => '<string>',
'regions' => [
],
'stock_exchange' => '',
'stock_ticker' => '',
'brand_contact_email' => '',
'representative_first_name' => '<string>',
'representative_last_name' => '<string>',
'representative_email' => 'jsmith@example.com',
'representative_phone' => '<string>',
'representative_title' => '<string>',
'street' => '<string>',
'city' => '<string>',
'region' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'campaign_description' => '<string>',
'message_flow' => '<string>',
'message_samples' => [
'<string>'
],
'privacy_policy_url' => '<string>',
'terms_url' => '<string>',
'has_links' => true,
'has_phone_numbers' => true,
'age_gated' => true,
'direct_lending' => true,
'consent_confirmed' => 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/phone-numbers/{id}/sms-registration"
payload := strings.NewReader("{\n \"action\": \"save\",\n \"details\": {\n \"legal_name\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"website\": \"<string>\",\n \"regions\": [],\n \"stock_exchange\": \"\",\n \"stock_ticker\": \"\",\n \"brand_contact_email\": \"\",\n \"representative_first_name\": \"<string>\",\n \"representative_last_name\": \"<string>\",\n \"representative_email\": \"jsmith@example.com\",\n \"representative_phone\": \"<string>\",\n \"representative_title\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"campaign_description\": \"<string>\",\n \"message_flow\": \"<string>\",\n \"message_samples\": [\n \"<string>\"\n ],\n \"privacy_policy_url\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"has_links\": true,\n \"has_phone_numbers\": true,\n \"age_gated\": true,\n \"direct_lending\": true,\n \"consent_confirmed\": true\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/phone-numbers/{id}/sms-registration")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"save\",\n \"details\": {\n \"legal_name\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"website\": \"<string>\",\n \"regions\": [],\n \"stock_exchange\": \"\",\n \"stock_ticker\": \"\",\n \"brand_contact_email\": \"\",\n \"representative_first_name\": \"<string>\",\n \"representative_last_name\": \"<string>\",\n \"representative_email\": \"jsmith@example.com\",\n \"representative_phone\": \"<string>\",\n \"representative_title\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"campaign_description\": \"<string>\",\n \"message_flow\": \"<string>\",\n \"message_samples\": [\n \"<string>\"\n ],\n \"privacy_policy_url\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"has_links\": true,\n \"has_phone_numbers\": true,\n \"age_gated\": true,\n \"direct_lending\": true,\n \"consent_confirmed\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration")
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 \"action\": \"save\",\n \"details\": {\n \"legal_name\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"website\": \"<string>\",\n \"regions\": [],\n \"stock_exchange\": \"\",\n \"stock_ticker\": \"\",\n \"brand_contact_email\": \"\",\n \"representative_first_name\": \"<string>\",\n \"representative_last_name\": \"<string>\",\n \"representative_email\": \"jsmith@example.com\",\n \"representative_phone\": \"<string>\",\n \"representative_title\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"campaign_description\": \"<string>\",\n \"message_flow\": \"<string>\",\n \"message_samples\": [\n \"<string>\"\n ],\n \"privacy_policy_url\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"has_links\": true,\n \"has_phone_numbers\": true,\n \"age_gated\": true,\n \"direct_lending\": true,\n \"consent_confirmed\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"registration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"details": {
"legal_name": "<string>",
"business_type": "Co-operative",
"industry": "AGRICULTURE",
"registration_type": "EIN",
"registration_number": "<string>",
"website": "<string>",
"regions": [
"AFRICA"
],
"company_type": "private",
"stock_exchange": "",
"stock_ticker": "",
"brand_contact_email": "",
"volume": "low",
"use_case": "LOW_VOLUME",
"representative_first_name": "<string>",
"representative_last_name": "<string>",
"representative_email": "jsmith@example.com",
"representative_phone": "<string>",
"representative_title": "<string>",
"representative_position": "Director",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>",
"campaign_description": "<string>",
"message_flow": "<string>",
"message_samples": [
"<string>"
],
"privacy_policy_url": "<string>",
"terms_url": "<string>",
"has_links": true,
"has_phone_numbers": true,
"age_gated": true,
"direct_lending": true,
"consent_confirmed": true
},
"phone_number_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"last_error": "<string>",
"paid_until": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"quote": {
"quote_ref": "<string>",
"setup_amount": 123,
"monthly_amount": 123,
"currency": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
},
"checkout_url": "<string>"
}Phone Numbers
Prepare or attach SMS registration
Requires phone_numbers:write. Save truthful business and consent details to receive a price quote. Attach reuses the paid approved workspace registration for another eligible number with the same business and messaging purpose, without an extra subscription. Use POST /billing/sms-registration with billing:write to confirm the price and open checkout.
POST
/
phone-numbers
/
{id}
/
sms-registration
Prepare or attach SMS registration
curl --request POST \
--url https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "save",
"details": {
"legal_name": "<string>",
"registration_number": "<string>",
"website": "<string>",
"regions": [],
"stock_exchange": "",
"stock_ticker": "",
"brand_contact_email": "",
"representative_first_name": "<string>",
"representative_last_name": "<string>",
"representative_email": "jsmith@example.com",
"representative_phone": "<string>",
"representative_title": "<string>",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>",
"campaign_description": "<string>",
"message_flow": "<string>",
"message_samples": [
"<string>"
],
"privacy_policy_url": "<string>",
"terms_url": "<string>",
"has_links": true,
"has_phone_numbers": true,
"age_gated": true,
"direct_lending": true,
"consent_confirmed": true
}
}
'import requests
url = "https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration"
payload = {
"action": "save",
"details": {
"legal_name": "<string>",
"registration_number": "<string>",
"website": "<string>",
"regions": [],
"stock_exchange": "",
"stock_ticker": "",
"brand_contact_email": "",
"representative_first_name": "<string>",
"representative_last_name": "<string>",
"representative_email": "jsmith@example.com",
"representative_phone": "<string>",
"representative_title": "<string>",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>",
"campaign_description": "<string>",
"message_flow": "<string>",
"message_samples": ["<string>"],
"privacy_policy_url": "<string>",
"terms_url": "<string>",
"has_links": True,
"has_phone_numbers": True,
"age_gated": True,
"direct_lending": True,
"consent_confirmed": True
}
}
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({
action: 'save',
details: {
legal_name: '<string>',
registration_number: '<string>',
website: '<string>',
regions: [],
stock_exchange: '',
stock_ticker: '',
brand_contact_email: '',
representative_first_name: '<string>',
representative_last_name: '<string>',
representative_email: 'jsmith@example.com',
representative_phone: '<string>',
representative_title: '<string>',
street: '<string>',
city: '<string>',
region: '<string>',
postal_code: '<string>',
country: '<string>',
campaign_description: '<string>',
message_flow: '<string>',
message_samples: ['<string>'],
privacy_policy_url: '<string>',
terms_url: '<string>',
has_links: true,
has_phone_numbers: true,
age_gated: true,
direct_lending: true,
consent_confirmed: true
}
})
};
fetch('https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration', 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/phone-numbers/{id}/sms-registration",
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([
'action' => 'save',
'details' => [
'legal_name' => '<string>',
'registration_number' => '<string>',
'website' => '<string>',
'regions' => [
],
'stock_exchange' => '',
'stock_ticker' => '',
'brand_contact_email' => '',
'representative_first_name' => '<string>',
'representative_last_name' => '<string>',
'representative_email' => 'jsmith@example.com',
'representative_phone' => '<string>',
'representative_title' => '<string>',
'street' => '<string>',
'city' => '<string>',
'region' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'campaign_description' => '<string>',
'message_flow' => '<string>',
'message_samples' => [
'<string>'
],
'privacy_policy_url' => '<string>',
'terms_url' => '<string>',
'has_links' => true,
'has_phone_numbers' => true,
'age_gated' => true,
'direct_lending' => true,
'consent_confirmed' => 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/phone-numbers/{id}/sms-registration"
payload := strings.NewReader("{\n \"action\": \"save\",\n \"details\": {\n \"legal_name\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"website\": \"<string>\",\n \"regions\": [],\n \"stock_exchange\": \"\",\n \"stock_ticker\": \"\",\n \"brand_contact_email\": \"\",\n \"representative_first_name\": \"<string>\",\n \"representative_last_name\": \"<string>\",\n \"representative_email\": \"jsmith@example.com\",\n \"representative_phone\": \"<string>\",\n \"representative_title\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"campaign_description\": \"<string>\",\n \"message_flow\": \"<string>\",\n \"message_samples\": [\n \"<string>\"\n ],\n \"privacy_policy_url\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"has_links\": true,\n \"has_phone_numbers\": true,\n \"age_gated\": true,\n \"direct_lending\": true,\n \"consent_confirmed\": true\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/phone-numbers/{id}/sms-registration")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"save\",\n \"details\": {\n \"legal_name\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"website\": \"<string>\",\n \"regions\": [],\n \"stock_exchange\": \"\",\n \"stock_ticker\": \"\",\n \"brand_contact_email\": \"\",\n \"representative_first_name\": \"<string>\",\n \"representative_last_name\": \"<string>\",\n \"representative_email\": \"jsmith@example.com\",\n \"representative_phone\": \"<string>\",\n \"representative_title\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"campaign_description\": \"<string>\",\n \"message_flow\": \"<string>\",\n \"message_samples\": [\n \"<string>\"\n ],\n \"privacy_policy_url\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"has_links\": true,\n \"has_phone_numbers\": true,\n \"age_gated\": true,\n \"direct_lending\": true,\n \"consent_confirmed\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration")
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 \"action\": \"save\",\n \"details\": {\n \"legal_name\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"website\": \"<string>\",\n \"regions\": [],\n \"stock_exchange\": \"\",\n \"stock_ticker\": \"\",\n \"brand_contact_email\": \"\",\n \"representative_first_name\": \"<string>\",\n \"representative_last_name\": \"<string>\",\n \"representative_email\": \"jsmith@example.com\",\n \"representative_phone\": \"<string>\",\n \"representative_title\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"campaign_description\": \"<string>\",\n \"message_flow\": \"<string>\",\n \"message_samples\": [\n \"<string>\"\n ],\n \"privacy_policy_url\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"has_links\": true,\n \"has_phone_numbers\": true,\n \"age_gated\": true,\n \"direct_lending\": true,\n \"consent_confirmed\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"registration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"details": {
"legal_name": "<string>",
"business_type": "Co-operative",
"industry": "AGRICULTURE",
"registration_type": "EIN",
"registration_number": "<string>",
"website": "<string>",
"regions": [
"AFRICA"
],
"company_type": "private",
"stock_exchange": "",
"stock_ticker": "",
"brand_contact_email": "",
"volume": "low",
"use_case": "LOW_VOLUME",
"representative_first_name": "<string>",
"representative_last_name": "<string>",
"representative_email": "jsmith@example.com",
"representative_phone": "<string>",
"representative_title": "<string>",
"representative_position": "Director",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>",
"campaign_description": "<string>",
"message_flow": "<string>",
"message_samples": [
"<string>"
],
"privacy_policy_url": "<string>",
"terms_url": "<string>",
"has_links": true,
"has_phone_numbers": true,
"age_gated": true,
"direct_lending": true,
"consent_confirmed": true
},
"phone_number_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"last_error": "<string>",
"paid_until": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"quote": {
"quote_ref": "<string>",
"setup_amount": 123,
"monthly_amount": 123,
"currency": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
},
"checkout_url": "<string>"
}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
Body
application/json