start

post

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

Starts a new session and returns the variables that have changed for the user. If the user/device does not exist, a new user will be created (see the createDisposition option below). This method requires your production API clientKey.

Body Params

JSON request body.

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_PROD_KEY

The Production 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.

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 CreateIfNeeded

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 CreateIfNeeded.

Allowed:

appVersion

string

The version of the app used on this device. E.g. 2.0.1.

systemName

string

The name of the OS the current device is running. E.g. iOS.

systemVersion

string

The version number of the OS the current device is running. E.g. 6.0.

browserName

string

The name of the browser the current device is running. E.g. Chrome.

browserVersion

string

The version number of the browser the current device is running. E.g. 17.0.

deviceName

string

A human-readable name representing the device.

deviceModel

string

The model name of the device. E.g. iPad.

iosPushToken

string

The token used for Apple iOS push notifications on this device.

gcmRegistrationId

string

The registration ID used for Google Cloud Messaging push notifications on this device.

webPushSubscription

string

The JSON-encoded subscription used for web push notifications on this device.

userAttributes

string

A map of user attributes as key-value pairs. Each key must be a string. Attributes are saved across sessions. Only supplied attributes will be updated (i.e., if you omit an existing attribute, it will be preserved). Example: {"gender":"F","age":21}.

locale

string

The current locale the user is in. E.g. en_US.

country

string

The country the user is in, specified by ISO 2-letter code. E.g. US for United States. Set to (detect) to detect the country based on the IP address of the user.

region

string

The region (state) the user is in. E.g. ca for California. Set to (detect) to detect the region based on the IP address of the user.

city

string

The city the user is in. E.g. San Francisco. Set to (detect) to detect the city based on the IP address of the user.

location

string

The location (latitude/longitude) of the user. E.g. 37.775,-122.4183. Set to (detect) to detect the location based on the IP address of the user.

locationAccuracyType

string

The type of location that is provided (IP, CELL, or GPS). Default: IP.

timezone

string

The timezone abbreviation for the user. See list of timezone abbreviations.

timezoneOffsetSeconds

number

The timezone offset from GMT in seconds.

background

boolean

Whether the app started in the background. In this case, the session won't be counted until resumeSession is executed. Default: false.

includeDefaults

boolean

Whether to include default ("defaults in code") values in output. Default: true.

Response

defaultA successful request will return a response array with an object that has a success value set to true, and no error or warning object. It will also include variables, messages and other details relevant to that user.