Skip to content

Person commands: update, delete

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

Reference for Person, one group of Person commands.

Person.update

Changes the given properties of a Person. Verb page.

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

Emits Person.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Person.
namestringThe legal or personal name.
verifiedbooleanTrue once the identity is verified.

Returns

OutputTypeRequiredDescription
personPersonrequiredThe Person.

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 Person.update --json '{"id":"person_sLqbXbW683","verified":true}'

Person.delete

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

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

Emits Person.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Person.

Returns

OutputTypeRequiredDescription
personPersonrequiredThe Person.

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