Deal routes: propose, win · StartupBuilder

Reference for Deal, one group of Deal routes.

Deal.propose

Propose sends a Deal’s buyer a Quote they accept to place an Order. Verb page.

Text

POST /{namespace}/deals/{deal}/propose

Path: deal. Body, as JSON: the other inputs. Emits Deal.proposed.

Inputs

Input	Type	Required	Description
`deal`	Deal	required	The qualified Deal.
`quote`	Quote	required	The Quote to send.

Returns

Output	Type	Required	Description
`deal`	Deal	required	The Deal with its Quote out.

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

Example

Terminal

curl -X POST https://api.sb/leaseline.app/deals/deal_NgACZ6DcII/propose \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quote":"qt_GZnH5OK100"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "deal": {
    "$id": "https://api.sb/leaseline.app/deals/deal_NgACZ6DcII",
    "$type": "Deal",
    "status": "Proposed"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Deal.propose",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Deal.win

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