margot

Grant Credits

Changed on

Add up to 50 support credits to the founder's account, once per ticket.

post/margot/actions/grant_credits

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/grant_credits
  • 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.

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'.

creditsnumber required

Credits to add, above 0 and at most 50.

reason'failed_task' | 'product_issue' | 'service_outage' | 'billing_issue' | 'goodwill' required
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.

credits_addednumber nullable
credit_balancenumber nullable

Changes