Campaign programs: update, delete

Reference for Campaign, one group of Campaign programs.

Campaign.update

Changes the given properties of a Campaign. Verb page.

Text

do: return await $.Campaign.update(input)

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Campaign.update({ id: 'campaign_NYwCp4DcII', budget: { amount: 29, currency: 'USD' } })"
  }
}

Campaign.delete

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