curl --request POST \
--url https://app.famulor.io/api/v1/platform/users/{user_id}/balance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"credits": 50,
"note": "Onboarding credit"
}
'import requests
url = "https://app.famulor.io/api/v1/platform/users/{user_id}/balance"
payload = {
"credits": 50,
"note": "Onboarding credit"
}
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({credits: 50, note: 'Onboarding credit'})
};
fetch('https://app.famulor.io/api/v1/platform/users/{user_id}/balance', 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/platform/users/{user_id}/balance",
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([
'credits' => 50,
'note' => 'Onboarding credit'
]),
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/platform/users/{user_id}/balance"
payload := strings.NewReader("{\n \"credits\": 50,\n \"note\": \"Onboarding credit\"\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/platform/users/{user_id}/balance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credits\": 50,\n \"note\": \"Onboarding credit\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/platform/users/{user_id}/balance")
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 \"credits\": 50,\n \"note\": \"Onboarding credit\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credits_balance": 123,
"plan_credits_balance": 123,
"source_credits_balance": 123,
"direction": "transfer"
}
}{
"error": {
"code": "invalid_request",
"message": "credits must be a non-zero number."
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "White-label platform access required."
}
}{
"error": {
"code": "not_found",
"message": "Customer not found."
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Transfer credits to or from a platform user
Transfers signed credits between your own workspace wallet and this customer’s workspace wallet. A positive credits value grants credits from your wallet to the customer; a negative value reclaims credits back from the customer into yours. Either direction requires the source wallet to cover the amount — a wallet balance never goes below zero, and an insufficient-balance attempt fails with 400 invalid_request rather than partially applying. Required scope: platform:write. Requires white-label platform access (a reseller workspace with the white-label entitlement, or a platform admin acting from a root workspace) plus a live owner/admin membership in the calling credential’s own workspace — see White Label API.
curl --request POST \
--url https://app.famulor.io/api/v1/platform/users/{user_id}/balance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"credits": 50,
"note": "Onboarding credit"
}
'import requests
url = "https://app.famulor.io/api/v1/platform/users/{user_id}/balance"
payload = {
"credits": 50,
"note": "Onboarding credit"
}
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({credits: 50, note: 'Onboarding credit'})
};
fetch('https://app.famulor.io/api/v1/platform/users/{user_id}/balance', 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/platform/users/{user_id}/balance",
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([
'credits' => 50,
'note' => 'Onboarding credit'
]),
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/platform/users/{user_id}/balance"
payload := strings.NewReader("{\n \"credits\": 50,\n \"note\": \"Onboarding credit\"\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/platform/users/{user_id}/balance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credits\": 50,\n \"note\": \"Onboarding credit\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/platform/users/{user_id}/balance")
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 \"credits\": 50,\n \"note\": \"Onboarding credit\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credits_balance": 123,
"plan_credits_balance": 123,
"source_credits_balance": 123,
"direction": "transfer"
}
}{
"error": {
"code": "invalid_request",
"message": "credits must be a non-zero number."
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "White-label platform access required."
}
}{
"error": {
"code": "not_found",
"message": "Customer not found."
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}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
Signed, non-zero. Positive grants credits from your workspace wallet into the customer's; negative reclaims credits back from the customer into yours. The source wallet must cover the amount — wallet balances never go below zero.
50
Optional audit note.
Pick a specific workspace when the customer has several in your scope; defaults to the one they own.
Response
New balances after the transfer.
Show child attributes
Show child attributes