maxLevel2classpersonaclick-fixed-position

Basic Details

Parameters used in all requests are described here.

Parameters

Name	Type	Requirement	Description
shop_id	string	required	Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
shop_secret	string	required	Store Secret Key in PersonaClick. Located there: Account > Settings > Store Settings
email	string	required if "phone" property doesn't use	Email of the user to be added to the static segment.
phone	string	required if "email" property doesn't use	The 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

language	js
theme	FadeToGrey

personaclick("segment", "add", params);

Request Type	Content-Type
https://api.personaclick.com/segments/add	POST	application/json

Parameters

Note
Only parameters related to the request for the adding user to the segment are listed here. See "Basic Details" above for more information on required parameters.

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

API Response Code

HTTP status code	Description
200 OK	The request was successful.
403 Forbidden	The request was unsuccessful.
404 Not Found	There are no mandatory parameters in the request.

API Response Data

The response is JSON type with the following properties:

Name	Type	Description
status	string	Current status. Can have one of two values: success - the request was successful error - the request was unsuccessful
message	string	The text of the error if it occurred

Request Example

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "add", {curl 'https://api.personaclick.com/segments/add' \
  -X  "segment_id": 100500,
    "email": "john.doe@examplestore.com",
    "phone": "+10000000000"
});

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "add", {
    "segment_id": 100500,
    "email": "john.doe@examplestore.com"
});

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "add", {
    "segment_id": 100500,
    "phone": "+10000000000"
});

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "add", {"segment_id": 100500});'POST' \
  -H 'content-type: application/json' \
  -d '{"shop_id":"0d42fd8b713d0752776ca589cc0056","shop_secret":"0123456789abcdef0123456789abcdef","email":"john.doe@examplemail.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

language	js
theme	FadeToGrey

personaclick("segment", "remove", params);

NameTypeRequirementDescriptionparamsObjectrequiredObject with request parameters.

Request parameters

NameTypeRequirementDescriptionsegment_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

Request

Endpoint	Request Type	Content-Type
https://api.personaclick.com/segments/remove	POST	application/json

Parameters

Note
Only parameters related to the request for the removing user from the segment are listed here. See "Basic Details" above for more information on required parameters.

API Response Code

HTTP status code	Description
200 OK	The request was successful.
403 Forbidden	The request was unsuccessful.
404 Not Found	There are no mandatory parameters in the request.

API Response Data

The response is JSON type with the following properties:

Name	Type	Description
status	string	Current status. Can have one of two values: success - the request was successful error - the request was unsuccessful
message	string	The text of the error if it occurred

Request Example

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "remove", {curl 'https://api.personaclick.com/segments/remove' \
  -X  "segment_id": 100500,
    "email": "john.doe@examplestore.com",
    "phone": "+10000000000"
});

Code Block

language	js
theme	FadeToGrey

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

Code Block

language	js
theme	FadeToGrey

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

Code Block

language	js
theme	FadeToGrey

personaclick("segment", "remove", {"segment_id": 100500});'POST' \
  -H 'content-type: application/json' \
  -d '{"shop_id":"0d42fd8b713d0752776ca589cc0056","shop_secret":"0123456789abcdef0123456789abcdef","email":"john.doe@examplemail.com","phone":"4400114527199","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

language	js
theme	FadeToGrey

personaclick("segment", "get", callback);

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

API response

TypeDescription

Request

Endpoint	Request Type
https://api.personaclick.com/segments/get	GET

Parameters

Note
See "Basic Details" above for more information on required parameters.

Name	Type	Description
segment_id	number/string	Segment ID. It's available in the PersonaClick account: CRM > Segments.

API Response Code

HTTP status code	Description
200 OK	The request was successful.
403 Forbidden	The request was unsuccessful.
404 Not Found	There are no mandatory parameters in the request.

API Response Data

The response is JSON type with the following properties:

Name

Type

Description

status

string

Available only in case of an error. Contains the "error" value in this case.

message

string

Available only in case of an error. Contains a description of the error.

(has no name)

Object array

Object array , each will have with the following properties:

id (number) - the Segment segment ID.
type (string) - the Segment Type. It - segment type, can have one of the following values: dynamic, static, dynamicrfm.

Request Example

of use

Code Block

language	js
theme	FadeToGrey

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

Table of Contents

curl 'https://api.personaclick.com/segments/get?shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef&email=john.doe%40examplemail.com'

Column

Page Navigation

Table of Contents

maxLevel	1
indent	0px
style	none

Related Pages

Filter by label (Content by label)

showLabels	false
showSpace	false
sort	title
cql	label = "segments"

Versions Compared

Old Version 1

New Version Current

Key

Basic Details

Parameters

Adding to a segment

Method Objective

Request

Request parameters

Parameters

API Response Code

API Response Data

Request Example

Removing from a segment

Method Objective

Syntax and parameters

Request parameters

Request

Parameters

API Response Code

API Response Data

Request Example

Getting the segment list

Method Objective

Syntax and parameters

API response

Request

Parameters

API Response Code

API Response Data

Request Example

Code Block
language js
theme FadeToGrey
personaclick("segment", "get", function(segments) { segments.forEach(function(segment) { console.log(segment.id); console.log(segment.type); }); });

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Basic Details

Parameters

Adding to a segment

Method Objective

Request

Request parameters

Parameters

API Response Code

API Response Data

Request Example

Removing from a segment

Method Objective

Syntax and parameters

Request parameters

Request

Parameters

API Response Code

API Response Data

Request Example

Getting the segment list

Method Objective

Syntax and parameters

API response

Request

Parameters

API Response Code

API Response Data

Request Example

Code BlocklanguagejsthemeFadeToGreypersonaclick("segment", "get", function(segments) { segments.forEach(function(segment) { console.log(segment.id); console.log(segment.type); }); });

Code Block
language js
theme FadeToGrey
personaclick("segment", "get", function(segments) { segments.forEach(function(segment) { console.log(segment.id); console.log(segment.type); }); });