block

post

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

Stops all data collection for a user going forward. block also erases any data previously associated with that user, including all of their attribute and analytics data. The block will take effect as soon as the “success” response is returned. It may take up to 15 days to delete the user’s data completely.

Note that the block call deletes a user's past data, but does not delete the user entirely. This allows you to use the unblock call to resume data collection.

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_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

The userId to block data collection for. Required unless you use deviceId. See below for details.

deviceId

string

The deviceId to block data collection for. Required if no userId. A deviceId block will only block data from devices where a user has not logged-in on the device. If a user has logged-in on the device before, you must call the block API with the userId.

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.

Response

Language

Credentials

URL

Response

Choose an example:

application/json

defaultThe default response for most API actions.