Documentation

POST /api/settings/business

Save the business settings.

RequestPOST /api/settings/business
AuthenticationSession cookie required
Handlerbackend/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

ParameterInTypeRequiredDescription
ff_sessioncookiestringOptionalThe 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_namebodystringOptionalThe trading name shown to customers.
support_email_localbodystringOptionalThe local part of the support address.
default_canned_subjectbodystringOptionalSubject of the default canned reply.
default_canned_bodybodystringOptionalBody of the default canned reply.
ai_email_modebodystringOptionalHow 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

200Saved.

FieldTypeDescription
statusstring`ok`.
settingsobjectThe settings as stored.

Errors

StatusReasonWhen
400no account yetNo account exists to attach settings to.

Related

Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.