Subscriptions (iOS SDK)

Method Objective

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

Syntax and parameters

sdk.manageSubscription(params)

Request parameters

Name	Type	Requirement	Description
email	string	optionally	The current user's Email.
phone	string	optionally	The current user's phone in full international format. A phone number in full international format may begin with a plus sign (+) followed by the country code, city (area) code, and phone number.
userExternalId	string	optionally	Store side user ID
userLoyaltyId	string	optionally	The Loyalty Program user ID (loyalty card)
telegramID	string	optionally	Telegram User ID
emailBulk	boolean	optionally	It changes the current user's subscription status to bulk email campaigns.
emailChain	boolean	optionally	It changes the current user's subscription status to triggered email campaigns.
emailTransactional	boolean	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.
smsBulk	boolean	optionally	It changes the current user's subscription status to bulk SMS campaigns.
smsChain	boolean	optionally	It changes the current user's subscription status to triggered SMS campaigns.
smsTransactional	boolean	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.
webPushBulk	boolean	optionally	It changes the current user's subscription status to bulk webpush campaigns.
webPushChain	boolean	optionally	It changes the current user's subscription status to triggered webpush campaigns.
webPushTransactional	boolean	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.
mobilePushBulk	boolean	optionally	It changes the current user's subscription status to bulk app campaigns.
mobilePushChain	boolean	optionally	It changes the current user's subscription status to triggered app campaigns.
mobilePushTransactional	boolean	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

sdk.manageSubscription(
    email: "john.doe@examplestore.com",
    phone: "+100000000000",
    emailBulk: true,
    emailChain: true,
    emailTransactional: true,
    smsBulk: true,
    smsChain: true,
    smsTransactional: true,
    webPushBulk: true,
    webPushChain: true,
    webPushTransactional: true,
    mobilePushBulk: true,
    mobilePushChain: true,
    mobilePushTransactional: true
)

sdk.manageSubscription(
    email: "john.doe@examplestore.com",
    emailBulk: true,
    emailChain: false,
    emailTransactional: true,
)

sdk.manageSubscription(
    phone: "+100000000000",
    smsBulk: false,
    smsChain: false,
    smsTransactional: true,
)

sdk.manageSubscription(
    emailTransactional: true,
    smsTransactional: true
)

Page Navigation

Related Pages