margot

Instruct Business

Changed on

Start one agent turn on the founder's business with the owner's request (gated, billed to the founder).

post/margot/actions/instruct_business

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/instruct_business
  • 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 required

The business, by its name or handle. Required: never auto-selected.

limitinteger nullable

Optional row limit for list actions.

requested_by'customer' | 'team' required

'customer': the Customer Agent acting on a founder's ticket. 'team': the Internal Agent acting for a teammate.

ticket_idstring required

The helpdesk ticket id (customer) or the Parahelp task id (team). A repeated call with the same ticket_id returns the first result instead of acting twice.

ticket_urlstring nullable

https link to the ticket or task, for the audit line.

team_memberstring nullable

The teammate's email. Required when requested_by is 'team'.

instructionstring required

What the business's agent should work on, in the owner's words, at most 1,000 characters.

notestring nullable

Internal note, never shown to the founder. Kept to its first 500 characters.

Response

Successful Response

foundboolean
outcome'done' | 'already_done' | 'pending' | 'refused' required

done: it happened now. already_done: an earlier call of this ticket already did it. pending: the refund went to the bank and its result is unknown, a teammate checks it. refused: nothing happened.

reasonstring nullable

The refusal or pending code. Null when done.

handoffboolean

True: hand the ticket to a human now.

company_namestring nullable
turn_startedboolean

The business's agent started working on it.

Changes