Versions Compared
compared with
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 | ||||
|---|---|---|---|---|
| ||||
PersonaClick.addToSegment(segmentId, email, phone) |
Request parameters
| Name | Type | Requirement | Description | ||
|---|---|---|---|---|---|
| segmentId | string | required | Segment ID. It's available in the PersonaClick account: CRM > Segments. | ||
| string | optionally | The current user's Email. | |||
| phone | string | optionally | The current user's phone in full international format.
|
Examples of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.addToSegment("100500", "john.doe@examplestore.com", "+10000000000");
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.addToSegment("100500", "john.doe@examplestore.com", null); |
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.addToSegment("100500", null, "+10000000000"); |
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.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 | ||||
|---|---|---|---|---|
| ||||
Personaclick.removeFromSegment(segmentId, email, phone) |
Request parameters
| Name | Type | Requirement | Description | ||
|---|---|---|---|---|---|
| segmentId | string | required | Segment ID. It's available in the PersonaClick account: CRM > Segments. | ||
| string | optionally | The current user's Email. | |||
| phone | string | optionally | The current user's phone in full international format.
|
Examples of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.removeFromSegment("100500", "john.doe@examplestore.com", "+10000000000");
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.removeFromSegment("100500", "john.doe@examplestore.com", null); |
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.removeFromSegment("100500", null, "+10000000000"); |
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.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 | ||||
|---|---|---|---|---|
| ||||
PersonaClick.getCurrentSegment(callback) |
| Name | Type | Requirement | Description |
|---|---|---|---|
| callback | Function | required | The callback function that takes the API response. The API response type is an object. See the example. |
API response
| Type | Description |
|---|---|
| Object array | Object array, each will have the following properties:
|
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
PersonaClick.getCurrentSegment(new Api.OnApiCallbackListener() {
@Override
public void onSuccess(JSONArray segments) {
// segments (type: array of objects)
}
});
|
| Column | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Page Navigation
Related Pages
|