Segment ID. It's available in the PersonaClick account: CRM > Segments.
email
string
optionally
The current user's Email.
phone
string
optionally
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.
Examples of use
pcsdk.segments("add", {
"segment_id": 100500,
"email": "john.doe@examplestore.com",
"phone": "+10000000000"
}).then((response) => {
// if the request is successful
}).catch((error) => {
// if something went wrong
});
pcsdk.segments("add", {
"segment_id": 100500,
"email": "john.doe@examplestore.com"
}).then((response) => {
// if the request is successful
}).catch((error) => {
// if something went wrong
});
pcsdk.segments("add", {
"segment_id": 100500,
"phone": "+10000000000"
}).then((response) => {
// if the request is successful
}).catch((error) => {
// if something went wrong
});
pcsdk.segments("add", {
"segment_id": 100500
}).then((response) => {
// if the request is successful
}).catch((error) => {
// if something went wrong
});
Removing from a segment
Method Objective
The method allows excluding the current user from a segment.
Segment ID. It's available in the PersonaClick account: CRM > Segments.
email
string
optionally
The current user's Email.
phone
string
optionally
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.
Examples of use
pcsdk.segments("remove", {
"segment_id": 100500,
"email": "john.doe@examplestore.com",
"phone": "+10000000000"
}).then((response) => {
// if the request is successful
}).catch((error) => {
// if something went wrong
});
pcsdk.segments("remove", {
"segment_id": 100500,
"email": "john.doe@examplestore.com"
}).then((response) => {
// if the request is successful
}).catch((error) => {
// if something went wrong
});
pcsdk.segments("remove", {
"segment_id": 100500,
"phone": "+10000000000"
}).then((response) => {
// if the request is successful
}).catch((error) => {
// if something went wrong
});
pcsdk.segments("remove", {
"segment_id": 100500
}).then((response) => {
// if the request is successful
}).catch((error) => {
// if something went wrong
});
Getting the segment list
Method Objective
The method allows getting a list of segments that include the current user.
Syntax and parameters
pcsdk.segments("get").then(success).catch(error)
Name
Type
Requirement
Description
success
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:
id (number) - the Segment ID.
type (string) - the Segment Type. It can have the following values: static, dynamic, rfm.
Example of use
pcsdk.segments("get").then((segments) => {
// if the request is successful
segments.forEach(segment => {
console.log(segment.id);
console.log(segment.type);
});
}).catch((error) => {
// if something went wrong
});