Skip to content

by Startups.Studio

Partner.update

PATCH /{namespace}/partners/{id}

Changes the given properties of a Partner.

Noun: Partner
Mode: do
Event: Partner.updated

You, to your agent

Change the latest partner.

curl -X PATCH https://api.sb/routewise.dev/partners/partner_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"side":"supply"}'

import { $ } from 'startup-builder'

const partner = await $.Partner.update({ id: 'partner_1', side: 'supply' })

npx startup-builder do Partner.update --json '{"id":"partner_1","side":"supply"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Partner.update({ id: 'partner_1', side: 'supply' })"
  }
}

Update changes the given properties of a Partner. It is inherited: every Noun has get, list, create, update and delete.

Inputs

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

Outputs

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

Effects

Emits Partner.updated.
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.update

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

Previous Page

Persona

Next Page