Skip to content

by Startups.Studio

OverviewOrganization

Organization.update

PATCH /{namespace}/organizations/{id}

Changes the given properties of an Organization.

Noun: Organization
Mode: do
Event: Organization.updated

You, to your agent

Change the organization “PetPantry”.

curl -X PATCH https://api.sb/petpantry.shop/organizations/organization_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"PetPantry"}'

import { $ } from 'startup-builder'

const organization = await $.Organization.update({ id: 'organization_1', name: 'PetPantry' })

npx startup-builder do Organization.update --json '{"id":"organization_1","name":"PetPantry"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Organization.update({ id: 'organization_1', name: 'PetPantry' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Organization.
`name`	`string`		The name it trades under.
`hostname`	`string`		The web domain that keys it.

Outputs

Output	Type	Required	Description
`organization`	Organization	required	The Organization.

Effects

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