Skip to content
CLIProductBuild and shipMapping

Mapping commands: update, delete

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

Reference for Mapping, one group of Mapping commands.

Mapping.update

Changes the given properties of a Mapping. Verb page.

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

Emits Mapping.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Mapping.
verbstringThe Verb it serves, such as Meeting.book; a Verb has many Mappings, ranked.
fieldsjsonEach outside field or event and the Noun property or Event it maps to.
directionstringboth still keeps db.sb the record; the outside tool never becomes a second one.
converttextHow a value changes on the way, such as cents to money or a picklist to closed values.
rankintegerOrder tried when the preferred Mapping fails or finds nothing; the Policy orders it by cost per accepted result.
preferredbooleanTrue for the Mapping a Verb tries first.
doorstringHow the outside endpoint is classed; an unclassed write is one-way and waits its delay window.

Returns

OutputTypeRequiredDescription
mappingMappingrequiredThe Mapping.

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 Mapping.update --json '{"id":"mapping_WOromrQi6J","verb":"Meeting.book"}'

Mapping.delete

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

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

Emits Mapping.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Mapping.

Returns

OutputTypeRequiredDescription
mappingMappingrequiredThe Mapping.

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