Skip to content

by Startups.Studio

Core grammar Source Integration

Integration.update

PATCH /{namespace}/integrations/{id}

Changes the given properties of an Integration.

Noun: Integration
Mode: do
Event: Integration.updated

You, to your agent

Change the latest integration.

curl -X PATCH https://api.sb/patentpad.com/integrations/integration_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scope":"studio"}'

import { $ } from 'startup-builder'

const integration = await $.Integration.update({ id: 'integration_1', scope: 'studio' })

npx startup-builder do Integration.update --json '{"id":"integration_1","scope":"studio"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Integration.update({ id: 'integration_1', scope: 'studio' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Integration.
`acquired`	`string`		One of `owned`, `wrapped`, or `recruited`.
`terms`	`text`		The terms the Startup holds the right to use and resell it under.
`scope`	`string`		One of `studio`, `startup`, or `customer`.
`sync`	`string`		Which side leads a sync connector: `platform` or `provider`.
`mode`	`string`		How records move: `mirror` writes db.sb out to the outside tool; `import` turns edits there into Changes. db.sb is the record in both.
`venue`	`string`		The id of the ad, social or app-store venue the account is on, when it is on one.
`account`	`string`		The outside account’s own id, such as an ad account, a workspace or a repository.
`grants`	`string[]`		The outside permissions the account holder approved: the narrowest set its Verbs need.
`connectedBy`	Party		Who approved the connection; a Human’s own account is used only under that Human’s Mandate.
`environment`	`string`		A `test` Integration reaches only the upstream’s test account, as a Stripe test account does.
`expiresAt`	`datetime`		When access lapses unless refreshed.
`refreshedAt`	`datetime`		When the platform last renewed the outside token.
`lastError`	`string`		The error slug of the last failed call or refresh, cleared by the next success.
`cursor`	`string`		Where the last sync run stopped, so the next run reads only what changed.

Outputs

Output	Type	Required	Description
`integration`	Integration	required	The Integration.

Effects

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

Integration.sync

Previous Page

System

Next Page