Skip to content

by Startups.Studio

Product Sites and apps Portal

Portal.update

PATCH /{namespace}/portals/{id}

Changes the given properties of a Portal.

Noun: Portal
Mode: do
Event: Portal.updated

You, to your agent

Change the latest portal.

curl -X PATCH https://api.sb/shiftnote.app/portals/portal_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"/"}'

import { $ } from 'startup-builder'

const portal = await $.Portal.update({ id: 'portal_1', path: '/' })

npx startup-builder do Portal.update --json '{"id":"portal_1","path":"/"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Portal.update({ id: 'portal_1', path: '/' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Portal.
`path`	`string`		Where it is mounted on the Site, `/portal` by default.
`tools`	`string[]`		Developer tools a keyed Offer adds: `keys`, `usage`, `requests`, `watches`, `version` and `testMode`.

Outputs

Output	Type	Required	Description
`portal`	Portal	required	The Portal.

Effects

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

Portal.list

Previous Page

Site

Next Page