Handle · StartupBuilder

Properties

Property	Type	Required	Description
`venue`	`string`	required	The venue it lives on, by id.
`name`	`string`	required	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.

Object

JSON

{
  "$id": "https://api.sb/tutorloop.com/handles/handle_1",
  "$type": "Handle",
  "venue": "Example venue",
  "name": "TutorLoop",
  "shared": true,
  "agent": true,
  "integration": "integration_1"
}

Relationships

A Handle publishes many Posts: every Post goes out from one Handle, so its reach and replies count toward that Handle. publishes, inverse handle.

Verbs

createCreates a Handle.
POST /{namespace}/handlesdoHandle.created
getReturns one Handle by id.
GET /{namespace}/handles/{id}readNo Event
listReturns Handles, newest first, one page at a time.
GET /{namespace}/handlesreadNo Event
updateChanges the given properties of a Handle.
PATCH /{namespace}/handles/{id}doHandle.updated
connectConnect binds a Handle to the Integration credential it publishes through, once the platform confirms the account.
POST /{namespace}/handles/{handle}/connectdoHandle.connected

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Handle.create`	Yes	Yes	Yes	No
`Handle.get`	Yes	Yes	Yes	Yes
`Handle.list`	Yes	Yes	Yes	Yes
`Handle.update`	Yes	Yes	Yes	No
`Handle.connect`	Yes	Yes	Yes	No

Call it

Text

Connect the latest handle with an integration.

Example

A recipe app holds the Handle @weeknightplates on two social venues, both bound to one Integration. An Agent runs them, and each bio says so.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link