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

NameRequirementDescription
emailoptionallyThe current user's Email.
phoneoptionally

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.


userExternalIdoptionallyStore side user ID
userLoyaltyIdoptionallyThe Loyalty Program user ID (loyalty card)
telegramIDoptionallyTelegram User ID
emailBulkoptionallyIt changes the current user's subscription status to bulk email campaigns.
emailChainoptionallyIt changes the current user's subscription status to triggered email campaigns.
emailTransactionaloptionally

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.


smsBulkoptionallyIt changes the current user's subscription status to bulk SMS campaigns.
smsChainoptionallyIt changes the current user's subscription status to triggered SMS campaigns.
smsTransactionaloptionally

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.


webPushBulkoptionallyIt changes the current user's subscription status to bulk webpush campaigns.
webPushChainoptionallyIt changes the current user's subscription status to triggered webpush campaigns.
webPushTransactionaloptionally

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.


mobilePushBulkoptionallyIt changes the current user's subscription status to bulk app campaigns.
mobilePushChainoptionallyIt changes the current user's subscription status to triggered app campaigns.
mobilePushTransactionaloptionally

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