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("segment", "add", params); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| params | Object | required | Object with request parameters. |
Request parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| segment_id | number/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. |
Examples of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "add", {
"segment_id": 100500,
"email": "john.doe@examplestore.com",
"phone": "+10000000000"
});
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "add", {
"segment_id": 100500,
"email": "john.doe@examplestore.com"
}); |
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "add", {
"segment_id": 100500,
"phone": "+10000000000"
}); |
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "add", {"segment_id": 100500}); |
Removing from a segment
Method Objective
The method allows excluding the current user from a segment.
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "remove", params); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| params | Object | required | Object with request parameters. |
Request parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| segment_id | number/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. |
Examples of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "remove", {
"segment_id": 100500,
"email": "john.doe@examplestore.com",
"phone": "+10000000000"
});
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "remove", {
"segment_id": 100500,
"email": "john.doe@examplestore.com"
}); |
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "remove", {
"segment_id": 100500,
"phone": "+10000000000"
}); |
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "remove", {"segment_id": 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 | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "get", callback); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| callback | Function | required | The callback function that takes the API response. The API response type is an object. |
API response
| Type | Description |
|---|---|
| Object array | Object array, each will have the following properties:
|
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("segment", "get", function(segments) {
segments.forEach(function(segment) {
console.log(segment.id);
console.log(segment.type);
});
});
|
| Table of Contents | ||||
|---|---|---|---|---|
|