Skip to content

Supplier commands: update, delete

The Supplier Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

Reference for Supplier, one group of Supplier commands.

Supplier.update

Changes the given properties of a Supplier. Verb page.

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

Emits Supplier.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Supplier.
namestringThe legal or personal name.
payoutAccountstringWhere payouts land, held through Stripe.

Returns

OutputTypeRequiredDescription
supplierSupplierrequiredThe Supplier.

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 Supplier.update --json '{"id":"supplier_QTsIMiLqO4","payoutAccount":"Example payout account"}'

Supplier.delete

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

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

Emits Supplier.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Supplier.

Returns

OutputTypeRequiredDescription
supplierSupplierrequiredThe Supplier.

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 Supplier.delete --json '{"id":"supplier_QTsIMiLqO4"}'