Partner · StartupBuilder

Properties

Property	Type	Required	Description
`side`	`string`	required	One of `supply`, `distribution`, or `both`.

Inherited from Organization: 2 properties

Property	Type	Required	Description
`name`	`string`	required	The name it trades under.
`hostname`	`string`		The web domain that keys it.

Object

JSON

{
  "$id": "https://api.sb/kilnbakery.com/partners/partner_1",
  "$type": "Partner",
  "name": "Kiln Bakery",
  "hostname": "kilnbakery.com",
  "side": "supply"
}

Relationships

A Partner reserves many Organizations: an Organization a Partner reserved before referring it, for the partner.reservationWindow Setting (90 days by default); outbound skips it. reserves, inverse reservedBy.

Verbs

createCreates a Partner.
POST /{namespace}/partnersdoPartner.created
getReturns one Partner by id.
GET /{namespace}/partners/{id}readNo Event
listReturns Partners, newest first, one page at a time.
GET /{namespace}/partnersreadNo Event
updateChanges the given properties of a Partner.
PATCH /{namespace}/partners/{id}doPartner.updated
deleteDeletes a Partner; its history is kept.
DELETE /{namespace}/partners/{id}doPartner.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Partner.create`	Yes	Yes	Yes	No
`Partner.get`	Yes	Yes	Yes	Yes
`Partner.list`	Yes	Yes	Yes	Yes
`Partner.update`	Yes	Yes	Yes	No
`Partner.delete`	Yes	Yes	Yes	No

Call it

Text

Add a partner to PetPantry.

Example

A practice-management vendor refers law firms to a court-filings API under an Agreement for 20% of first-year revenue. It is a Partner on the distribution side.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link