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 |
Manage Subscriptions
Method Objective
The method allows changing the status of the current user's subscriptions to notification channels.
Request
| Endpoint | Request Type | Content-Type |
|---|---|---|
| https://api.personaclick.com/subscriptions/manage | POST | application/x-www-form-urlencoded |
Parameters
| Note |
|---|
See "Basic Details" above for more information on required parameters. |
Name | Type | Description |
|---|---|---|
| string | The current user's Email. | |
| phone | string | The current user's Phone. |
| email_bulk | boolean | It changes the current user's subscription status to bulk email campaigns. |
| email_chain | boolean | It changes the current user's subscription status to triggered email campaigns. |
| email_transactional | boolean | It changes the current user's subscription status for transactional email campaigns. |
| sms_bulk | boolean | It changes the current user's subscription status to bulk SMS campaigns. |
| sms_chain | boolean | It changes the current user's subscription status to triggered SMS campaigns. |
| sms_transactional | boolean | It changes the current user's subscription status for transactional SMS campaigns. |
API Response Code
HTTP status code | Description |
|---|---|
| 200 OK | The request was successful. |
| 400 Bad Request | There are no parameters to change the status of subscriptions. |
| 403 Forbidden | The request was unsuccessful. |
| 404 Not Found | There are no mandatory parameters in the query. |
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/subscriptions/manage' \ -X 'POST' \ -H 'content-type: application/x-www-form-urlencoded' \ -d 'email=john.doe%40examplemail.com&email_bulk=true&email_chain=true&email_transactional=false&sms_bulk=false&sms_chain=true&sms_transactional=false&shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef' |
System Operations
Method Objective
The method allows marking email addresses with system statuses and unsubscribing from all types of campaigns.
Request
| Endpoint | Request Type | Content-Type |
|---|---|---|
| https://api.personaclick.com/subscriptions/callback | POST | application/x-www-form-urlencoded |
Parameters
| Note |
|---|
See "Basic Details" above for more information on required parameters. |
Name | Type | Description |
|---|---|---|
| event | string | Specifies the action to be performed with the email. Available values:
|
| string | Email address for marking. |
API Response Code
HTTP status code | Description |
|---|---|
| 200 OK | The request was successful. |
| 400 Bad Request | There are no event parameter, or the paramenter has an incorrect value. |
| 403 Forbidden | The request was unsuccessful. |
| 404 Not Found | There are no mandatory parameters in the query. |
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 | ||||
|---|---|---|---|---|
| ||||
# test
curl 'https://api.personaclick.com/subscriptions/manage' \
-X 'POST' \
-H 'content-type: application/x-www-form-urlencoded' \
-d 'email=john.doe%40examplemail.com&email_bulk=true&email_chain=true&email_transactional=false&sms_bulk=false&sms_chain=true&sms_transactional=false&shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef' |
Subscription Statuses
List of Subscription Changes
| Table of Contents | ||||
|---|---|---|---|---|
|