Handle programs: update · StartupBuilder

Reference for Handle, one group of Handle programs.

Handle.update

Changes the given properties of a Handle. Verb page.

Text

do: return await $.Handle.update(input)

Emits Handle.updated.

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.

Returns

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

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

Example

JSON

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