Documentation

Mistake on this page? Email us

UpdateCampaignUpdateRequest

Hierarchy

  • UpdateCampaignUpdateRequest

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

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 targets. Refer to this using the filter ID.

example

state__eq=registered

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

016e83dce36a00000000000100100102

when

when: Date

The scheduled start time for the campaign. The campaign will start within 1 minute when then start time has elapsed.

example

2017-05-22T12:37:55.576563Z