addAndroidNotificationChannel

post

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

Creates new notification channels and updates existing ones. Updateable parameters include channel name, description, and default. This method requires your development API clientKey.

Leanplum will not interfere with any channel defined directly in your app code or by other mobile marketing providers. For instance, if your app has both a “Promotions” channel and a “Transactional” channel, but your marketer should only have access to Promotions, then you should only send that channel to Leanplum.

Body Params

JSON request body with variables and values.

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:

string

required

The channel ID. Also used when updating existing channels.

name

string

required

The human-readable name that will appear on the Leanplum dashboard (e.g. Promotions, Transactional, etc.). Should be distinguishable from all other channel names.

importance

number

required

Defaults to 3

Sets the importance of all notifications in the channel, which determines how much the channel can interrupt the user. The default is 3: notifications will show everywhere, make noise, but does not visually intrude. For more, see the Android documentation.

description

string

The user-visible description of this channel.

groupId

string

See Android docs here.

enableLights

boolean

Whether to enable lights.

lightColor

number

See Android docs for available colors.

enableVibration

boolean

Whether to enable vibration.

vibrationPattern

array of numbers

See Android docs here.

vibrationPattern

lockscreenVisibility

number

See Android documentation here.

bypassDnd

boolean

See Android docs here.

showBadge

boolean

Whether to show badge.

sound

string

URI of sound file, which must be stored locally on the device. See Andoroid Docs here.

default

boolean

This is a Leanplum parameter, indicating whether this channel should be the default channel referenced in the dashboard. Leanplum automatically defines the first channel you create as the “default” channel, preventing the dashboard user from having to manually choose a channel for every campaign.

Response

defaultThe response will indicate whether or not the channel was created successfully.