Documentation

Mistake on this page? Email us

UpdateCampaignCreateRequest

Hierarchy

  • UpdateCampaignCreateRequest

Index

Properties

approvalRequired

approvalRequired: boolean

Flag indicating whether approval is needed to start the campaign.

example

false

autostop

autostop: boolean

Flag indicating whether the campaign should be auto-stopped on reaching a threshold.

example

false

autostopSuccessPercent

autostopSuccessPercent: number

Percent of successful device updates to auto stop the campaign.

example

85.00

campaignStrategy

campaignStrategy: UpdateCampaignStrategy

How the campaign adds devices. A one-shot campaign does not add new devices after it has started. A continuous campaign means that devices may be added to the campaign after it has started. The default is one-shot.

description

description: string

An optional description of the campaign.

example

This campaign updates Class XX devices to version 1.34

deviceFilter

deviceFilter: string

The filter for the devices the campaign is targeting at.

example

id__eq=00000000000000000000000000000000

name

name: string

The campaign name.

example

campaign

rootManifestId

rootManifestId: string

The ID of the manifest that will be sent to the device as part of the campaign.

example

00000000000000000000000000000000