Documentation

Mistake on this page? Email us

Hierarchy

Index

Properties

description

description: string

An optional description of the campaign

deviceFilter

deviceFilter: object

The device filter to use

Constructed like so:

 deviceFilter: {
   state: { $eq: "bootstrapped" },
   createdAt: { $gte: new Date("01-01-2014"), $lte: new Date("01-01-2018") },
   updatedAt: { $gte: new Date("01-01-2014"), $lte: new Date("01-01-2018") },
   customAttributes: {
     <custom_name_1>: { $eq: "custom_value_1" },
     <custom_name_2>: { $ne: "custom_value_2" }
   }
 }

Type declaration

manifestId

manifestId: string

ID of the manifest to use for update

name

name: string

A name for this campaign

object

object: string

The API resource entity

scheduledAt

scheduledAt: Date

The timestamp at which update campaign scheduled to start

state

The state of the campaign