Organization commands: update, delete
The Organization Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Organization, one group of Organization commands.
Organization.update
Changes the given properties of an Organization. Verb page.
npx startup-builder do Organization.update --json '<input>' [--try | --send | --do]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
npx startup-builder do Organization.update --json '{"id":Organization.delete
Deletes an Organization: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Organization.delete --json '<input>' [--try | --send | --do]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
npx startup-builder do Organization.delete --json '{"id":