Handle routes: update · StartupBuilder

Reference for Handle, one group of Handle routes.

Handle.update

Changes the given properties of a Handle. Verb page.

Text

PATCH /{namespace}/handles/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

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

JSON

{
  "api": "https://api.sb/leaseline.app",
  "handle": {
    "$id": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
    "$type": "Handle",
    "venue": "Example venue",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Handle.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Handle.updateCopy Anchor Link

Handle.update