Documentation

POST /api/ads-manager

Save the campaign book.

RequestPOST /api/ads-manager
AuthenticationSession cookie required
Handlerbackend/server.py

What it does

Writes the whole book back. An oversized book is refused with 413 rather than truncated.

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.
bookbodyobjectRequiredThe complete book — `campaigns`, `next` and `settings`.
actionbodystringOptionalThe named operation to apply instead of a whole-book save.

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 '{"book":"<object>","action":"<string>"}' \
  "https://flowfinds.ai/api/ads-manager"
const res = await fetch("https://flowfinds.ai/api/ads-manager", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "book": "<object>",
    "action": "<string>"
  }),
});
const data = await res.json();
import requests

s = requests.Session()
r = s.post("https://flowfinds.ai/api/ads-manager", json={
    "book": "<object>",
    "action": "<string>"
  })
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"book":{"campaigns":[],"next":1,"settings":{}}}' \
  "$FLOWFINDS_ORIGIN/api/ads-manager"

Responses

200Saved.

FieldTypeDescription
statusstring`saved`.

Errors

StatusReasonWhen
400unknown_actionThe action is not one the handler defines.
409The book conflicts with the stored one.
413The book exceeds the accepted size.

Related

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