Skip to content

by Startups.Studio

Deal.create

POST /{namespace}/deals

Creates a Deal.

Noun: Deal
Mode: do
Event: Deal.created

You, to your agent

Add a deal to TutorLoop.

curl -X POST https://api.sb/tutorloop.com/deals \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":{"amount":60,"currency":"USD"}}'

import { $ } from 'startup-builder'

const deal = await $.Deal.create({ value: { amount: 60, currency: 'USD' } })

npx startup-builder do Deal.create --json '{"value":{"amount":60,"currency":"USD"}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Deal.create({ value: { amount: 60, currency: 'USD' } })"
  }
}

Create makes a new Deal from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`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.
`organization`	Organization		Each Deal has one buying Organization on the other side.
`referral`	Referral		The Deals a Referral opened; when one is won, its revenue earns the Partner’s Commission.

Outputs

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

Effects

Emits Deal.created.
Two-way: try, send, do.

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

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

Previous Page

Deal.delete

Next Page