Documentation

POST /api/organic/approve

Approve a researched campaign for a platform and scope.

RequestPOST /api/organic/approve
AuthenticationSession cookie required
Handlerbackend/organic.py

What it does

Records an approval with its scopes. This writes the approval log; it does not post to any platform. Approval and execution are separate rows, and the log shows whether anything was ever executed against an approval.

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.
platformbodystringRequiredThe platform being approved for.
querybodystringRequiredThe researched query being approved.
scopesbodystring[]RequiredWhat the approval covers.

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 '{"platform":"<string>","query":"<string>","scopes":"<string[]>"}' \
  "https://flowfinds.ai/api/organic/approve"
const res = await fetch("https://flowfinds.ai/api/organic/approve", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "platform": "<string>",
    "query": "<string>",
    "scopes": "<string[]>"
  }),
});
const data = await res.json();
import requests

s = requests.Session()
r = s.post("https://flowfinds.ai/api/organic/approve", json={
    "platform": "<string>",
    "query": "<string>",
    "scopes": "<string[]>"
  })
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"platform":"…","query":"…","scopes":["…"]}' \
  "$FLOWFINDS_ORIGIN/api/organic/approve"

Responses

200The approval was recorded.

200Refused.

FieldTypeDescription
statusstring`refused`.
reasonstring`nothing_to_approve`.
explanationstringThe reason's sentence.

Errors

This endpoint has no failure path of its own. An uncaught exception anywhere in the engine is still returned as structured JSON by the shared guard.

Related

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