Skip to content

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.

Text
npx startup-builder do Partner.update --json '<input>' [--try | --send | --do]

Emits Partner.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Partner.
namestringThe name it trades under.
hostnamestringThe web domain that keys it.
sidestringOne of supply, distribution, or both.

Returns

OutputTypeRequiredDescription
partnerPartnerrequiredThe Partner.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
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.

Text
npx startup-builder do Partner.delete --json '<input>' [--try | --send | --do]

Emits Partner.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Partner.

Returns

OutputTypeRequiredDescription
partnerPartnerrequiredThe Partner.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Partner.delete --json '{"id":"partner_YcEOEgSexq"}'