Versions Compared

Old Version 3

changes.mady.by.user Andrey Veprikov

Saved on

compared with

New Version Current

changes.mady.by.user Andrey Veprikov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method Objective

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

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
pcsdk.subscriptions("manage", params);

NameTypeRequirementDescription
paramsObjectrequiredObject with request parameters.

Request parameters

NameTypeRequirementDescription
emailstringoptionallyThe current user's Email.
phonestringoptionally

The current user's phone in full international format.

Tip

A phone number in full international format may begin with a plus sign (+) followed by the country code, city (area) code, and phone number.


external_idstringoptionallyStore side user ID.
loyalty_idstringoptionallyThe Loyalty Program user ID (loyalty card).
telegram_idstringoptionallyTelegram User ID.
email_bulkbooleanoptionallyIt changes the current user's subscription status to bulk email campaigns.
email_chainbooleanoptionallyIt changes the current user's subscription status to triggered email campaigns.
email_transactionalbooleanoptionally

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

Note

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


sms_bulkbooleanoptionallyIt changes the current user's subscription status to bulk SMS campaigns.
sms_chainbooleanoptionallyIt changes the current user's subscription status to triggered SMS campaigns.
sms_transactionalbooleanoptionally

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

Note

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


web_push_bulkbooleanoptionallyIt changes the current user's subscription status to bulk webpush campaigns.
web_push_chainbooleanoptionallyIt changes the current user's subscription status to triggered webpush campaigns.
web_push_transactionalbooleanoptionally

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

Note

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


mobile_push_bulkbooleanoptionallyIt changes the current user's subscription status to bulk app campaigns.
mobile_push_chainbooleanoptionallyIt changes the current user's subscription status to triggered app campaigns.
mobile_push_transactionalbooleanoptionally

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

Note

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


Examples of use

Code Block
languagejs
themeFadeToGrey
pcsdk.subscriptions("manage", {
    email: "john.doe@examplestore.com",
    phone: "+100000000000",
    email_bulk: true,
    email_chain: true,
    email_transactional: true,
    sms_bulk: true,
    sms_chain: true,
    sms_transactional: true,
    web_push_bulk: true,
    web_push_chain: true,
    web_push_transactional: true,
    mobile_push_bulk: true,
    mobile_push_chain: true,
    mobile_push_transactional: true
});

Code Block
languagejs
themeFadeToGrey
pcsdk.subscriptions("manage", {
    email: "john.doe@examplestore.com",
    email_bulk: true,
    email_chain: false,
    email_transactional: true,
});

Code Block
languagejs
themeFadeToGrey
pcsdk.subscriptions("manage", {
    phone: "+100000000000",
    sms_bulk: false,
    sms_chain: false,
    sms_transactional: true
});

Code Block
languagejs
themeFadeToGrey
pcsdk.subscriptions("manage", {
    email_transactional: true,
    sms_transactional: true
});



Column

Page Navigation

Table of Contents
maxLevel3
indent0px
stylenone



Related Pages

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
sorttitle
cqllabel = "subscriptions"