Versions Compared

Old Version 1

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.

Adding to a segment

Method Objective

The method allows adding the current user to a segment.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
PersonaClicksdk.addToSegment(segmentId, email, phone)

Request parameters

NameTypeRequirementDescription
segmentIdstringrequiredSegment ID. It's available in the PersonaClick account: CRM > Segments.
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.


Examples of use

Code Block
languagejs
themeFadeToGrey
PersonaClicksdk.addToSegment("100500", "john.doe@examplestore.com", "+10000000000");


Code Block
languagejs
themeFadeToGrey
PersonaClicksdk.addToSegment("100500", "john.doe@examplestore.com", null);


Code Block
languagejs
themeFadeToGrey
PersonaClicksdk.addToSegment("100500", null, "+10000000000");


Code Block
languagejs
themeFadeToGrey
PersonaClicksdk.addToSegment("100500", null, null);


Removing from a segment

Method Objective

The method allows excluding the current user from a segment.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
Personaclicksdk.removeFromSegment(segmentId, email, phone)

Request parameters

NameTypeRequirementDescription
segmentIdstringrequiredSegment ID. It's available in the PersonaClick account: CRM > Segments.
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.


Examples of use

Code Block
languagejs
themeFadeToGrey
PersonaClicksdk.removeFromSegment("100500", "john.doe@examplestore.com", "+10000000000");


Code Block
languagejs
themeFadeToGrey
PersonaClicksdk.removeFromSegment("100500", "john.doe@examplestore.com", null);


Code Block
languagejs
themeFadeToGrey
PersonaClicksdk.removeFromSegment("100500", null, "+10000000000");


Code Block
languagejs
themeFadeToGrey
PersonaClicksdk.removeFromSegment("100500", null, null);


Getting the segment list

Method Objective

The method allows getting a list of segments that include the current user.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
PersonaClicksdk.getCurrentSegment(callback)

NameTypeRequirementDescription
callbackFunctionrequiredThe callback function that takes the API response. The API response type is an object. See the example.

API response

TypeDescription
Object array

Object array, each will have the following properties:

  • id (number) - the Segment ID.
  • type (string) - the Segment Type. It can have the following values: static, dynamic, rfm.

Example of use

Code Block
languagejs
themeFadeToGrey
PersonaClick.getCurrentSegment(newobject : Api.OnApiCallbackListener() {
    @Overrideoverride     public void fun onSuccess(segments: JSONArray segments) {
      // segments (type: array of objects)
    }
});



Column

Page Navigation

Table of Contents
maxLevel2
indent0px
stylenone



Related Pages

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