Audience commands: update, delete
The Audience Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Audience, one group of Audience commands.
Audience.update
Changes the given properties of an Audience. Verb page.
npx startup-builder do Audience.update --json '<input>' [--try | --send | --do]Emits Audience.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Audience. |
type | list of Noun | The Nouns this Thing is an instance of. | |
outside | json | The ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating. | |
query | json | The saved query that defines a dynamic Collection. | |
size | integer | How many people match. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
audience | Audience | required | The Audience. |
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 Audience.update --json '{"id":Audience.delete
Deletes an Audience: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Audience.delete --json '<input>' [--try | --send | --do]Emits Audience.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Audience. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
audience | Audience | required | The Audience. |
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 Audience.delete --json '{"id":