Skip to content

by Startups.Studio

Handle.update

PATCH /{namespace}/handles/{id}

Changes the given properties of a Handle.

Noun: Handle
Mode: do
Event: Handle.updated

You, to your agent

Change the handle “ShiftNote”.

curl -X PATCH https://api.sb/shiftnote.app/handles/handle_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"ShiftNote"}'

import { $ } from 'startup-builder'

const handle = await $.Handle.update({ id: 'handle_1', name: 'ShiftNote' })

npx startup-builder do Handle.update --json '{"id":"handle_1","name":"ShiftNote"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Handle.update({ id: 'handle_1', name: 'ShiftNote' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Handle.
`venue`	`string`		The venue it lives on, by id.
`name`	`string`		The name as the platform shows it, such as `@example`.
`shared`	`boolean`		True for a Studio account shared across sibling Startups; every Post names the Startup it speaks for.
`agent`	`boolean`		True when an Agent runs it; its bio says so.
`integration`	Integration		The Integration credential it publishes through.

Outputs

Output	Type	Required	Description
`handle`	Handle	required	The Handle.

Effects

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

Handle.list

Previous Page

Hypothesis

Next Page