Skip to content

by Startups.Studio

Deal.win

POST /{namespace}/deals/{deal}/win

Win closes a Deal as won, which places its Order and makes the buyer a Customer.

Noun: Deal
Mode: do
Event: Deal.won

You, to your agent

Win the latest deal.

curl -X POST https://api.sb/tutorloop.com/deals/deal_1/win \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { order, deal } = await $.Deal.win({ deal: 'deal_1' })

npx startup-builder do Deal.win --json '{"deal":"deal_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Deal.win({ deal: 'deal_1' })"
  }
}

Inputs

Input	Type	Required	Description
`deal`	Deal	required	The proposed Deal.

Outputs

Output	Type	Required	Description
`order`	Order	required	The placed Order.
`deal`	Deal	required	The Deal, now won.

Effects

Emits Deal.won.
Performed by the Sales Lead.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Deal.win
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Deal.win

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Deal.update

Previous Page

Renewal

Next Page