Campaign commands: update, delete
The Campaign Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Campaign, one group of Campaign commands.
Campaign.update
Changes the given properties of a Campaign. Verb page.
npx startup-builder do Campaign.update --json '<input>' [--try | --send | --do]Emits Campaign.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Campaign. |
budget | money | What it may spend. | |
startsAt | datetime | When it starts. | |
endsAt | datetime | When it ends. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
campaign | Campaign | required | The Campaign. |
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 Campaign.update --json '{"id":Campaign.delete
Deletes a Campaign: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Campaign.delete --json '<input>' [--try | --send | --do]Emits Campaign.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Campaign. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
campaign | Campaign | required | The Campaign. |
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 Campaign.delete --json '{"id":