Manage Segments (RN SDK)

Owned by Andrey Veprikov
Last updated: Aug 24, 2023
2 min read

Adding to a segment

Method Objective

The method allows adding the current user to a segment.

Syntax and parameters

pcsdk.segments("add", params).then(success).catch(error)

NameTypeRequirementDescription
paramsObjectrequiredObject with request parameters.

Request parameters

NameTypeRequirementDescription
segment_idnumber/stringrequiredSegment 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.

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.

Syntax and parameters

pcsdk.segments("remove", params).then(success).catch(error)

NameTypeRequirementDescription
paramsObjectrequiredObject with request parameters.

Request parameters

NameTypeRequirementDescription
segment_idnumber/stringrequiredSegment 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.

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)

NameTypeRequirementDescription
successFunctionrequiredThe callback function that takes the API response. The API response type is an object.

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

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
});

Page Navigation



Related Pages

Copyright 2018-2024 PersonaClick