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 | ||||
|---|---|---|---|---|
| ||||
sdk.addToSegment(params) |
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 | ||||
|---|---|---|---|---|
| ||||
sdk.addToSegment(segmentId: "100500", email: "john.doe@examplestore.com", phone: "+10000000000") |
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.addToSegment(segmentId: "100500", email: "john.doe@examplestore.com") |
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.addToSegment(segmentId: "100500", phone: "+10000000000") |
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.addToSegment(segmentId: "100500") |
Removing from a segment
Method Objective
The method allows excluding the current user from a segment.
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.removeFromSegment(params) |
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 | ||||
|---|---|---|---|---|
| ||||
sdk.removeFromSegment(segmentId: "100500", email: "john.doe@examplestore.com", phone: "+10000000000") |
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.removeFromSegment(segmentId: "100500", email: "john.doe@examplestore.com") |
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.removeFromSegment(segmentId: "100500", phone: "+10000000000") |
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.removeFromSegment(segmentId: "100500") |
Getting the segment list
Method Objective
The method allows getting a list of segments that include the current user.
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.getCurrentSegment() |
API response
| Type | Description |
|---|---|
| Object array | Object array, each will have the following properties:
|
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
let segments = sdk.getCurrentSegment() |
| Column | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Page Navigation
Related Pages
|