Versions Compared

Old Version 1

changes.mady.by.user Andrey Veprikov

Saved on

compared with

New Version 2

changes.mady.by.user Andrey Veprikov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Basic Details

Parameters used in all requests are described here.

Parameters

NameTypeRequirementDescription
shop_idstringrequiredUnique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
shop_secretstringrequiredStore Secret Key in PersonaClick. Located there: Account > Settings > Store Settings
emailstringrequired if "phone" property doesn't useEmail of the user to be added to the static segment.
phonestringrequired if "email" property doesn't useThe phone number of the user to be added to the static segment.

Adding to a segment

Method Objective

The method allows adding the current user to a segment.

Syntax and parameters

Request

codeNameTypeRequirementDescriptionparamsObjectrequiredObject with request parameters.

Request parameters

NameTypeRequirement
Endpoint
languagejs
themeFadeToGrey
personaclick("segment", "add", params);
Request TypeContent-Type
https://api.personaclick.com/segments/addPOSTapplication/x-www-form-urlencoded

Parameters

Note

Only parameters related to the profile update request are listed here. See "Basic Details" above for more information on required parameters and the API endpoint.


Name

Type

Description

segment_id

number/string
required

Segment ID. It's available in the PersonaClick account: CRM > Segments.

emailstringoptionallyThe current user's Email.phonestringoptionally

The current user's Phone.

Examples of use

Code Block
languagejs
themeFadeToGrey
personaclick("segment", "add", {
    "segment_id": 100500,
    "email": "john.doe@examplestore.com",
    "phone": "+10000000000"
});
Code Block
languagejs
themeFadeToGrey
personaclick("segment", "add", { "segment_id": 100500, "email": "john.doe@examplestore.com" });

API Response Code

HTTP status code

Description
200 OK

The request was successful.

403 ForbiddenThe request was unsuccessful.
404 Not FoundThere are no mandatory parameters in the query.

API Response Data

The response is JSON type with the following properties:

NameTypeDescription
statusstring

Current status. Can have one of two values:

  • success - the request was successful
  • error - the request was unsuccessful
messagestring

The text of the error if it occurred

Request Example

Code Block
languagejs
themeFadeToGrey
personaclick("segment", "add", {curl 'https://api.personaclick.com/segments/add' \
    "segment_id": 100500,
-H 'content-type: application/x-www-form-urlencoded' \
   "phone": "+10000000000"
});
Code Block
languagejs
themeFadeToGrey
personaclick("segment", "add", {"segment_id": 100500});-d 'shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef&email=john.doe%40examplemail.com&phone=4400114527199&segment_id=100500'


Removing from a segment

Method Objective

The method allows excluding the current user from a segment.

Syntax and parameters

Code Block
languagejs
themeFadeToGrey
personaclick("segment", "remove", params);

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.

Examples of use

Code Block
languagejs
themeFadeToGrey
personaclick("segment", "remove", {
    "segment_id": 100500,
    "email": "john.doe@examplestore.com",
    "phone": "+10000000000"
});


Code Block
languagejs
themeFadeToGrey
personaclick("segment", "remove", {
    "segment_id": 100500,
    "email": "john.doe@examplestore.com"
});


Code Block
languagejs
themeFadeToGrey
personaclick("segment", "remove", {
    "segment_id": 100500,
    "phone": "+10000000000"
});


Code Block
languagejs
themeFadeToGrey
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
languagejs
themeFadeToGrey
personaclick("segment", "get", callback);

NameTypeRequirementDescription
callbackFunctionrequiredThe 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.

Example of use

Code Block
languagejs
themeFadeToGrey
personaclick("segment", "get", function(segments) {
    segments.forEach(function(segment) {
        console.log(segment.id);
        console.log(segment.type);
    });
});


Table of Contents
maxLevel2
classpersonaclick-fixed-position