Deal routes: update, delete

Reference for Deal, one group of Deal routes.

Deal.update

Changes the given properties of a Deal. Verb page.

Text

PATCH /{namespace}/deals/{id}

Path: id. Body, as JSON: the other inputs. Emits Deal.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Deal.
`value`	`money`		What the Deal is worth if won.
`owner`	Worker		The Worker who runs it.
`closesOn`	`date`		The date the buyer expects to decide.
`nextStep`	`text`		The next dated step agreed with the buyer.

Returns

Output	Type	Required	Description
`deal`	Deal	required	The Deal.

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.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/deals/deal_NgACZ6DcII \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":{"amount":29,"currency":"USD"}}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "deal": {
    "$id": "https://api.sb/leaseline.app/deals/deal_NgACZ6DcII",
    "$type": "Deal",
    "status": "Open",
    "value": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Deal.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Deal.delete

Deletes a Deal: a soft delete that keeps its history, undone by Thing.restore. Verb page.