Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Current »

Method Objective

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

Syntax and parameters

personaclick("subscription", "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.

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.

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.

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.

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.

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

Examples of use

personaclick("subscription", "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
});

personaclick("subscription", "manage", {
    email: "john.doe@examplestore.com",
    email_bulk: true,
    email_chain: false,
    email_transactional: true,
});

personaclick("subscription", "manage", {
    phone: "+100000000000",
    sms_bulk: false,
    sms_chain: false,
    sms_transactional: true
});

personaclick("subscription", "manage", {
    email_transactional: true,
    sms_transactional: true
});
  • No labels