Skip to content

by Startups.Studio

Partner.create

POST /{namespace}/partners

Creates a Partner.

Noun: Partner
Mode: do
Event: Partner.created

You, to your agent

Add a partner to PetPantry.

curl -X POST https://api.sb/petpantry.shop/partners \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"PetPantry","side":"supply"}'

import { $ } from 'startup-builder'

const partner = await $.Partner.create({ name: 'PetPantry', side: 'supply' })

npx startup-builder do Partner.create --json '{"name":"PetPantry","side":"supply"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Partner.create({ name: 'PetPantry', side: 'supply' })"
  }
}

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

Inputs

Input	Type	Required	Description
`name`	`string`	required	The name it trades under.
`hostname`	`string`		The web domain that keys it.
`side`	`string`	required	One of `supply`, `distribution`, or `both`.

Outputs

Output	Type	Required	Description
`partner`	Partner	required	The Partner.

Effects

Emits Partner.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.	Partner.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`.

Partner

Previous Page

Partner.delete

Next Page