Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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 |
| 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.
Request
| Endpoint | Request Type | Content-Type |
|---|---|---|
| https://api.personaclick.com/segments/add | POST | application/x-www-form-urlencodedjson |
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 and the API endpoint. |
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 queryrequest. |
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:
|
| message | string | The text of the error if it occurred |
Request Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl 'https://api.personaclick.com/segments/add' \ -X 'POST' \ -H 'content-type: application/x-www-form-urlencodedjson' \ -d '{"shop_id=0d42fd8b713d0752776ca589cc0056&":"0d42fd8b713d0752776ca589cc0056","shop_secret=0123456789abcdef0123456789abcdef&email=john.doe%40examplemail.com&phone=4400114527199&segment_id=100500":"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.
Request
| Endpoint | Request Type | Content-Type |
|---|---|---|
| https://api.personaclick.com/segments/remove | POST | application/x-www-form-urlencodedjson |
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 and the API endpoint. |
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 queryrequest. |
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:
|
| message | string | The text of the error if it occurred |
Request Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl 'https://api.personaclick.com/segments/remove' \ -X 'POST' \ -H 'content-type: application/x-www-form-urlencodedjson' \ -d '{"shop_id=0d42fd8b713d0752776ca589cc0056&":"0d42fd8b713d0752776ca589cc0056","shop_secret=0123456789abcdef0123456789abcdef&email=john.doe%40examplemail.com&phone=4400114527199&segment_id=100500":"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.
Request
| Endpoint | Request Type |
|---|---|
| https://api.personaclick.com/segments/get | GET |
Parameters
| Note |
|---|
See "Basic Details" above for more information on required parameters and the API endpoint. |
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 queryrequest. |
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 with the following properties:
|
Request Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl 'https://api.personaclick.com/segments/get?shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef&email=john.doe%40examplemail.com' |
| Column | ||||
|---|---|---|---|---|
Page Navigation
|
Related Pages
|