margot

Business State

Changed on

Why one of the caller's businesses runs, sells and chats the way it does now (ungated read).

The turn gates and the checkout links' state, from the code that enforces them (:mod:use_cases.support.business_state).

post/margot/actions/business_state

Request

  • Base URL: https://api.nanocorp.so (the document declares no server; this is the origin it was published from)
  • URL: https://api.nanocorp.so/margot/actions/business_state
  • Auth: HTTP bearer

Request body

external_idstring nullable

The founder's NanoCorp user id (external_id on the helpdesk contact).

emailstring nullable

The founder's email. Used as a fallback identity and a cross-check.

companystring nullable

Optional company name/handle hint, resolved against the caller's own companies.

limitinteger nullable

Optional row limit for list actions.

Response

Successful Response

foundboolean
harnessstring nullable

'v3' or 'classic' (the older dashboard and controls).

scheduled_runsstring nullable

'on' or 'off': the Scheduled runs switch in Ops. 'off' is what the app calls 'paused'; chat still works. Null for a business that is not founded yet or is archived.

site_pausedboolean

The owner turned the Website switch off.

selling_pausedboolean

Checkout is off: by the owner, by the plan ending, or by the Light plan parking it.

selling_paused_by_plan_expiryboolean

Checkout was turned off because the plan ended, not by the owner.

parked_by_light_planboolean

The Light plan keeps one business active and parked this one (site, checkout and scheduled runs off). Upgrading to Founder restores its checkout only; the owner then turns Scheduled runs and the Website switch back on.

outbound_email_pausedboolean

The owner turned Outbound email off.

prospecting_pausedboolean

The owner turned Prospecting off.

ads_enabledboolean

Ads are turned on for this business.

plansinteger

Active monthly plans. A plan is never on the general links: the site sells it, and its TEST LINK in Products tests it.

plan_tierstring nullable
plan_expiredboolean
free_planboolean

The account is on the free plan: chat and edits run on its free credits, while checkout, outbound email, a second business and the agent's daily work after the first days take the Founder plan.

credit_balancenumber nullable
credit_floornumber nullable

Below this balance no agent turn starts.

Changes