Skip to content

by Startups.Studio

Core grammar Relationship

Relationship.update

PATCH /{namespace}/relationships/{id}

Changes the given properties of a Relationship.

Noun: Relationship
Mode: do
Event: Relationship.updated

You, to your agent

Change the latest relationship.

curl -X PATCH https://api.sb/shiftnote.app/relationships/relationship_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provenance":"Stated"}'

import { $ } from 'startup-builder'

const relationship = await $.Relationship.update({ id: 'relationship_1', provenance: 'Stated' })

npx startup-builder do Relationship.update --json '{"id":"relationship_1","provenance":"Stated"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Relationship.update({ id: 'relationship_1', provenance: 'Stated' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Relationship.
`predicate`	`string`		The name read from the source, such as `makes`.
`inverse`	`string`		The name read from the target, such as `madeBy`.
`provenance`	`string`		Who asserted it: `Stated`, `Ratified`, `Inferred`, or `Observed`.

Outputs

Output	Type	Required	Description
`relationship`	Relationship	required	The Relationship.

Effects

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

Relationship.list

Previous Page

Secret

Next Page