Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthDeal

Deal routes: advance, assign, lose

The Deal Verbs advance, assign, lose as api.sb routes, with inputs, result, refusals and an example.

Reference for Deal, one group of Deal routes.

Deal.advance

Advance moves a Deal to its next stage once every field that stage requires is filled. Verb page.

Text
POST /{namespace}/deals/{deal}/advance

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

Inputs

InputTypeRequiredDescription
dealDealrequiredThe Deal.
stagestringThe target stage; omitted, the next one.

Returns

OutputTypeRequiredDescription
dealDealrequiredThe Deal in its new stage.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/deals/deal_NgACZ6DcII/advance \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "deal": {
    "$id": "https://api.sb/leaseline.app/deals/deal_NgACZ6DcII",
    "$type": "Deal",
    "status": "Open"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Deal.advance",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Deal.assign

Assign gives a Deal one owner Worker, who carries its next step until it is won or lost. Verb page.

Text
POST /{namespace}/deals/{deal}/assign

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

Inputs

InputTypeRequiredDescription
dealDealrequiredThe Deal.
ownerWorkerThe Worker to own it; omitted, the routing Policy picks.

Returns

OutputTypeRequiredDescription
dealDealrequiredThe Deal, with its owner.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/deals/deal_NgACZ6DcII/assign \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "deal": {
    "$id": "https://api.sb/leaseline.app/deals/deal_NgACZ6DcII",
    "$type": "Deal",
    "status": "Open"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Deal.assign",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Deal.lose

Lose closes a Deal as lost and records the reason the buyer gave. Verb page.

Text
POST /{namespace}/deals/{deal}/lose

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

Inputs

InputTypeRequiredDescription
dealDealrequiredThe open Deal.
reasontextrequiredWhy the buyer passed.

Returns

OutputTypeRequiredDescription
dealDealrequiredThe lost Deal.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse 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.refusedRead 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/lose \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "deal": {
    "$id": "https://api.sb/leaseline.app/deals/deal_NgACZ6DcII",
    "$type": "Deal",
    "status": "Lost"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Deal.lose",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

propose, win

Next