Organization methods: update, delete

Organization.update

Changes the given properties of an Organization. Verb page.

TypeScript

interface OrganizationVerbs {
  update(input: OrganizationUpdateInput, options?: SB.CallOptions): SB.Call<Organization>
}

Emits Organization.updated.

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.

Returns

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

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

TypeScript

import { $ } from 'startup-builder'

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

Deletes an Organization: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface OrganizationVerbs {
  delete(input: OrganizationDeleteInput, options?: SB.CallOptions): SB.Call<Organization>
}

Emits Organization.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Organization.

Returns

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

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

TypeScript

import { $ } from 'startup-builder'

const organization = await $.Organization.delete({ id: 'organization_v0SkRLrXCN' })