Get platform settings
curl --request GET \
--url https://app.autocalls.ai/api/white-label/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.autocalls.ai/api/white-label/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.autocalls.ai/api/white-label/settings', 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.autocalls.ai/api/white-label/settings",
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.autocalls.ai/api/white-label/settings"
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.autocalls.ai/api/white-label/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.autocalls.ai/api/white-label/settings")
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": {
"welcome_email": {
"subject": "Welcome to {tenant_name}, {user_name}!",
"preheader": null,
"greeting_text": "Welcome {user_name}!",
"content": "<p>Thanks for joining {tenant_name}. Your account is ready.</p>",
"journey_text": null,
"questions_text": "If you have any questions, reach out to:",
"contact_email": "[email protected]",
"signature_text": "Best,<br>{tenant_name} team"
},
"email_notifications": {
"welcome_email": true,
"low_balance_alert": true,
"auto_topup_notification": true,
"low_chat_credits_alert": true,
"chat_credits_auto_topup_notification": true,
"trial_ending_reminder": true,
"voice_cloning_completed": true,
"phone_number_deleted": true,
"import_completed": true,
"export_completed": false,
"automation_usage_alert": true,
"automation_usage_alert_email": null
},
"scripts": {
"scripts": "<script src=\"https://chat.example.com/widget.js\" async></script>",
"scripts_auth": null
},
"appearance": {
"hide_pages": ["hide_api_page", "hide_blacklist_page"],
"hide_features": ["hide_carrier_costs", "hide_platform_tour"],
"hide_countries": [],
"plan_billing_display": "both",
"relabel_minutes_as_credits": false,
"allow_sign_ups": true
},
"webhooks": {
"user_signup_webhook_url": "https://example.com/hooks/signup"
},
"checkout": {
"require_tax_id": false
}
}
}
{
"message": "Unauthenticated."
}
{
"message": "You are not an administrator."
}
{
"message": "You do not have access to these settings."
}
{
"message": "Too Many Attempts."
}
White Label
Get platform settings
Get the settings of your white label platform
GET
/
white-label
/
settings
Get platform settings
curl --request GET \
--url https://app.autocalls.ai/api/white-label/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.autocalls.ai/api/white-label/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.autocalls.ai/api/white-label/settings', 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.autocalls.ai/api/white-label/settings",
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.autocalls.ai/api/white-label/settings"
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.autocalls.ai/api/white-label/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.autocalls.ai/api/white-label/settings")
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": {
"welcome_email": {
"subject": "Welcome to {tenant_name}, {user_name}!",
"preheader": null,
"greeting_text": "Welcome {user_name}!",
"content": "<p>Thanks for joining {tenant_name}. Your account is ready.</p>",
"journey_text": null,
"questions_text": "If you have any questions, reach out to:",
"contact_email": "[email protected]",
"signature_text": "Best,<br>{tenant_name} team"
},
"email_notifications": {
"welcome_email": true,
"low_balance_alert": true,
"auto_topup_notification": true,
"low_chat_credits_alert": true,
"chat_credits_auto_topup_notification": true,
"trial_ending_reminder": true,
"voice_cloning_completed": true,
"phone_number_deleted": true,
"import_completed": true,
"export_completed": false,
"automation_usage_alert": true,
"automation_usage_alert_email": null
},
"scripts": {
"scripts": "<script src=\"https://chat.example.com/widget.js\" async></script>",
"scripts_auth": null
},
"appearance": {
"hide_pages": ["hide_api_page", "hide_blacklist_page"],
"hide_features": ["hide_carrier_costs", "hide_platform_tour"],
"hide_countries": [],
"plan_billing_display": "both",
"relabel_minutes_as_credits": false,
"allow_sign_ups": true
},
"webhooks": {
"user_signup_webhook_url": "https://example.com/hooks/signup"
},
"checkout": {
"require_tax_id": false
}
}
}
{
"message": "Unauthenticated."
}
{
"message": "You are not an administrator."
}
{
"message": "You do not have access to these settings."
}
{
"message": "Too Many Attempts."
}
This endpoint returns the settings of your white label platform that you can also change through the API. Each section matches a tab of Settings in your administration panel:
The allowed values of every key, the placeholders you can use in the welcome email and the signup webhook payload are described in Update platform settings.
welcome_email (Email Templates), email_notifications (Email Notifications), scripts (Custom Scripts), appearance (Custom Appearance), webhooks (Webhooks) and checkout (Checkout). Other settings, such as branding, custom domain and SMTP, are managed in the administration panel only.
This endpoint is available to the account owner (with an active plan) and to team members with Settings Access. The
checkout section is only included for the owner and for team members who also have Billing Access. Other users receive a 403 Forbidden error.Response
object
Your platform settings, grouped by section
Show data properties
Show data properties
object
The welcome email sent to new users. Every key is a string, or
null when the default text is used.Show welcome_email properties
Show welcome_email properties
string
Email subject
string
Preview text shown in the inbox before the email is opened
string
Heading at the top of the email
string
Main body of the email, in HTML
string
Message shown before the contact details
string
Text shown before the contact email
string
Support email address shown in the email
string
Signature at the end of the email
object
One boolean per email your users can receive:
true means the email is sent. Also contains automation_usage_alert_email, the address that receives automation usage alerts instead of your users, or null when each user receives their own. trial_ending_reminder is only included when free trials are enabled for your platform. See Update platform settings for what each email is.object
object
What your users see on your platform
Show appearance properties
Show appearance properties
string[]
Pages hidden from your users’ navigation
string[]
Features and buttons hidden from your users
string[]
Country codes hidden when your users buy a phone number
string
Billing cycles shown on the plans page:
both, monthly or yearlyboolean
Whether “Minutes” is shown to your users as “Calling credits”
boolean
Whether visitors can create an account on your platform.
true unless you turned sign-ups offobject
Your webhooks
Show webhooks properties
Show webhooks properties
string
The URL called each time a new user signs up, or
null when the webhook is off{
"data": {
"welcome_email": {
"subject": "Welcome to {tenant_name}, {user_name}!",
"preheader": null,
"greeting_text": "Welcome {user_name}!",
"content": "<p>Thanks for joining {tenant_name}. Your account is ready.</p>",
"journey_text": null,
"questions_text": "If you have any questions, reach out to:",
"contact_email": "[email protected]",
"signature_text": "Best,<br>{tenant_name} team"
},
"email_notifications": {
"welcome_email": true,
"low_balance_alert": true,
"auto_topup_notification": true,
"low_chat_credits_alert": true,
"chat_credits_auto_topup_notification": true,
"trial_ending_reminder": true,
"voice_cloning_completed": true,
"phone_number_deleted": true,
"import_completed": true,
"export_completed": false,
"automation_usage_alert": true,
"automation_usage_alert_email": null
},
"scripts": {
"scripts": "<script src=\"https://chat.example.com/widget.js\" async></script>",
"scripts_auth": null
},
"appearance": {
"hide_pages": ["hide_api_page", "hide_blacklist_page"],
"hide_features": ["hide_carrier_costs", "hide_platform_tour"],
"hide_countries": [],
"plan_billing_display": "both",
"relabel_minutes_as_credits": false,
"allow_sign_ups": true
},
"webhooks": {
"user_signup_webhook_url": "https://example.com/hooks/signup"
},
"checkout": {
"require_tax_id": false
}
}
}
{
"message": "Unauthenticated."
}
{
"message": "You are not an administrator."
}
{
"message": "You do not have access to these settings."
}
{
"message": "Too Many Attempts."
}
Rate limit
The platform settings, default limits, user settings and plan endpoints share a limit of 60 requests per minute for each account. Above it they return429, and the Retry-After response header tells you how many seconds to wait.
Example
curl -X GET https://app.autocalls.ai/api/white-label/settings \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"

