View Source

Method Objective

The method allows changing the status of the current user's subscriptions to notification channels.

Syntax and parameters

sdk.manageSubscription(email, phone, external_id, loyalty_id, telegram_id, HashMap<String, Boolean>)

Request parameters

Name	Requirement	Description
email	optionally	The current user's Email.
phone	optionally	The current user's Phone.
external_id	optionally	Store side user ID.
loyalty_id	optionally	The Loyalty Program user ID (loyalty card).
telegram_id	optionally	The current user's Telegram ID.
HashMap<String, Boolean>	required	Subscription Statuses. See the example below.

Available subscription statuses

Name

Requirement

Description

email_bulk

optionally

It changes the current user's subscription status to bulk email campaigns.

email_chain

optionally

It changes the current user's subscription status to triggered email campaigns.

email_transactional

optionally

It changes the current user's subscription status for transactional email campaigns.

It's recommended that always use the "true" value, even if you don't use transactional messages.

sms_bulk

optionally

It changes the current user's subscription status to bulk SMS campaigns.

sms_chain

optionally

It changes the current user's subscription status to triggered SMS campaigns.

sms_transactional

optionally

It changes the current user's subscription status for transactional SMS campaigns.

It's recommended that always use the "true" value, even if you don't use transactional messages.

web_push_bulk

optionally

It changes the current user's subscription status to bulk webpush campaigns.

web_push_chain

optionally

It changes the current user's subscription status to triggered webpush campaigns.

web_push_transactional

optionally

It changes the current user's subscription status for transactional webpush campaigns.

It's recommended that always use the "true" value, even if you don't use transactional messages.

mobile_push_bulk

optionally

It changes the current user's subscription status to bulk app campaigns.

mobile_push_chain

optionally

It changes the current user's subscription status to triggered app campaigns.

mobile_push_transactional

optionally

It changes the current user's subscription status for transactional app campaigns.

It's recommended that always use the "true" value, even if you don't use transactional messages.

Examples of use

val subscriptions = HashMap<String, Boolean>()
subscriptions["email_bulk"] = true
subscriptions["email_chain"] = true
subscriptions["email_transactional"] = true
subscriptions["sms_bulk"] = true
subscriptions["sms_chain"] = true
subscriptions["sms_transactional"] = true
subscriptions["web_push_bulk"] = true
subscriptions["web_push_chain"] = true
subscriptions["web_push_transactional"] = true
subscriptions["mobile_push_bulk"] = true
subscriptions["mobile_push_chain"] = true
subscriptions["mobile_push_transactional"] = true
sdk.manageSubscription("john.doe@examplestore.com", "+100000000000", "100500", "12345-abcdf", 12345678, subscriptions)

val subscriptions = HashMap<String, Boolean>()
subscriptions["email_bulk"] = true
subscriptions["email_chain"] = false
subscriptions["email_transactional"] = true
sdk.manageSubscription("john.doe@examplestore.com", null, null, null, null, subscriptions)

val subscriptions = HashMap<String, Boolean>()
subscriptions["sms_bulk"] = false
subscriptions["sms_chain"] = false
subscriptions["sms_transactional"] = true
sdk.manageSubscription(null, "+100000000000", null, null, null, subscriptions)

val subscriptions = HashMap<String, Boolean>()
subscriptions["email_transactional"] = true
subscriptions["sms_transactional"] = true
sdk.manageSubscription(null, null, null, null, null, subscriptions)

Page Navigation

Related Pages