Documentation
POST /api/settings/business
Save the business settings.
| Request | POST /api/settings/business |
|---|---|
| Authentication | Session cookie required |
| Handler | backend/server.py |
What it does
Writes the settings back and returns them as stored.
Authentication
Session cookie required. Send the ff_session cookie. Without one the engine treats the caller as a new visitor with no holds and no claims, and returns a new cookie to use from then on.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ff_session | cookie | string | Optional | The session identifier. Omit it on the first call and store the value the response sets; every later call must send the same one or the engine treats the caller as a new visitor with no holds and no claims. |
business_name | body | string | Optional | The trading name shown to customers. |
support_email_local | body | string | Optional | The local part of the support address. |
default_canned_subject | body | string | Optional | Subject of the default canned reply. |
default_canned_body | body | string | Optional | Body of the default canned reply. |
ai_email_mode | body | string | Optional | How much authority the email agent has. |
Request
The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.
curl -s -b cookies.txt -c cookies.txt \
-X POST -H 'Content-Type: application/json' \
-d '{"business_name":"<string>","support_email_local":"<string>","default_canned_subject":"<string>","default_canned_body":"<string>","ai_email_mode":"<string>"}' \
"https://flowfinds.ai/api/settings/business"const res = await fetch("https://flowfinds.ai/api/settings/business", {
method: "POST",
credentials: "include",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
"business_name": "<string>",
"support_email_local": "<string>",
"default_canned_subject": "<string>",
"default_canned_body": "<string>",
"ai_email_mode": "<string>"
}),
});
const data = await res.json();import requests
s = requests.Session()
r = s.post("https://flowfinds.ai/api/settings/business", json={
"business_name": "<string>",
"support_email_local": "<string>",
"default_canned_subject": "<string>",
"default_canned_body": "<string>",
"ai_email_mode": "<string>"
})
data = r.json()Recorded example
curl -s -b cookies.txt -c cookies.txt \
-X POST -H 'Content-Type: application/json' \
-d '{"business_name":"…"}' \
"$FLOWFINDS_ORIGIN/api/settings/business"Responses
200 — Saved.
| Field | Type | Description |
|---|---|---|
status | string | `ok`. |
settings | object | The settings as stored. |
Errors
| Status | Reason | When |
|---|---|---|
400 | no account yet | No account exists to attach settings to. |
Related
POST /api/account— Save the account a claim is credited to.POST /api/login/request— Request a sign-in link.POST /api/logout— Sign out.GET /api/settings/business— The business settings the support desk reads.GET /api/settings/payout— The payout destination.POST /api/settings/payout— Save the payout destination.POST /api/settings/rules— Manage the support desk's keyword rules.
Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.