startCampaign

post

https://api.leanplum.com/api?action=startCampaign

Activates a campaign for one device or user. You must provide a deviceId and/or a userId. If deviceId is provided, the campaign top-level actions will be sent to the corresponding device only; if only userId is provided, the campaign top-level actions will be sent to all devices of the user with specified userId. If the user/device does not exist, sending the actions will be skipped. You can modify this behavior with the createDisposition option (see below).

This method requires your development API clientKey.

Body Params

appId

string

required

Defaults to YOUR_APP_ID

The application ID. To find yours, select your app in the navigation column, and click Manage Apps. Then click Keys & Settings.

clientKey

string

required

Defaults to YOUR_DEV_KEY

The Development key for your Leanplum App.

apiVersion

string

enum

required

Defaults to 1.0.6

The version of the Leanplum API to use. The current version is 1.0.6.

Allowed:

userId

string

required

Defaults to hfarnsworth

The current user ID. You can set this to whatever your company uses for user IDs. Leave it blank to use the device ID. For more info, see selecting a user.

deviceId

string

A unique ID for the device targeted by the request. You must provide a deviceId and/or a userId. See selecting a user.

campaignId

number

required

The ID of the campaign is found in the URL when viewing a campaign (e.g. www.leanplum.com/dashboard2/[APP_ID]/composer/[CAMPAIGN_ID]/audience}). Note that there might be multiple IDs in the URL, the campaign ID is right after composer/.

values

string

A JSON object of key-value pairs to override template variables used in the campaign actions. See below for example.

devMode

boolean

Defaults to false

Whether the user is in Development Mode, i.e. the user associated with the request is a developer and not a user. This is important for reporting purposes. Default: false.

createDisposition

string

enum

Defaults to CreateNever

The policy that determines whether users are created by the API. Possible values:

CreateIfNeeded creates a user with the given IDs if one does not already exist.
CreateNever requires that the user already exists, otherwise the API action is skipped and a warning will be returned.

The default value for this method is CreateNever.

Allowed:

Response

defaultThe default response for most API actions.