Partner commands: update, delete
The Partner Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Partner, one group of Partner commands.
Partner.update
Changes the given properties of a Partner. Verb page.
npx startup-builder do Partner.update --json '<input>' [--try | --send | --do]Emits Partner.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Partner. |
name | string | The name it trades under. | |
hostname | string | The web domain that keys it. | |
side | string | One of supply, distribution, or both. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
partner | Partner | required | The Partner. |
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 Partner.update --json '{"id": "partner_YcEOEgSexq", "side": "supply"}'Partner.delete
Deletes a Partner: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Partner.delete --json '<input>' [--try | --send | --do]Emits Partner.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Partner. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
partner | Partner | required | The Partner. |
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 Partner.delete --json '{"id": "partner_YcEOEgSexq"}'