Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Method Objective
The method gives the next promo code from the requested list of promo codes.
Syntax and parameters
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("get_promo_code", params, success, error); |
| Name | Type | Requirement | Description |
|---|---|---|---|
| params | object | required | Object with request parameters. See below. |
| success | function | required | A callback function, to which the API response will be passed. Response type: string. |
| error | function | optionally | A callback function that will be called when an error occurs (any HTTP status code other than 200), including when the list of promo codes is empty. |
Request parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| id | number/string | required | Unique ID of the promo code list. |
API response
| Type | Description |
|---|---|
| string | Next promo code from the requested list |
| Note |
|---|
The received promo code is cached for 2 hours for the current user's device. The end of the caching period is shifted by 2 hours each time if the user opens pages of the site during the caching period. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
personaclick("get_promo_code", {id: 100500}, function(code) {
// the functionality of using promo code
}, function(error) {
// when something went wrong
}); |
| Table of Contents | ||
|---|---|---|
|