createMultiCurrencyPassOffer

📘

You can try that method by clicking here

Parameters

Name

Type

Description

publisherToken*

string

You can find your publisher token at api-keys page.

offerData*

object

No description

-price*

float

Offer price (in publisher's currency)

-period*

string

Pass period: day / week / 2weeks / month / 3months / 6months / year

-title*

string

Title of the offer, up to 70 chars.

-url*

string

Url to content

-description

string

Additional offer description, up to 110 chars

-accessToTags

array

To which tags customer has access. Multiple tags are defined as "OR" (not "AND"). Set "(all)" if you want to give access to all of your offers.

localizedData*

array

-country*

string

2-letter country code

-currency*

string

Choose one: USD, EUR, GBP, CAD, AUD, NZD, SEK, DKK, NOK, TRL, ZAR, XOF

-price*

float

value between 0.14 and 99.99

-title*

string

Title of the offer, up to 70 chars.

-url*

string

Url to content

-description

string

Additional offer description, up to 110 chars

-geoRestrictionEnabled

bool

Set "true" to enable geo-restriction on this offer

-geoRestrictionType

string

Choose type of geo-restriction: whitelist / blacklist

-geoRestrictionCountries

array

Based on geoRestrictionType, set the array of whitelisted/blacklisted countries.

API Request/Response

Request

{
    "method":"createMultiCurrencyPassOffer",
    "params":{
      "publisherToken":"klj_nerb324sPLfhmzLtp4mDmdc8slwNNyAdt-1Xn2Hy0Icfay",
      "offerData":{
        "price":"10",
        "title":"Tasty and healthy food",
        "period":"2weeks",
        "url":"http:\/\/www.testoffer.com",
        "description":"Test offer description",
        "tags":[

        ]
      },
      "localizedData":[
        {
          "country":"US",
          "currency":"USD",
          "price":"10",
          "title":"Test offer for US customers"
        },
        {
          "country":"FR",
          "currency":"EUR",
          "price":"8",
          "title":"Test offer for French customers",
          "url":"http:\/\/testoffer.com\/fr"
        }
      ]
    },
    "jsonrpc":"2.0",
    "id":1
}

Response

{
        "result": {
            "multiCurrencyOfferId": "P841924054",
            "offers": [{
                "id": "P841924054_US",
                "publisherEmail": "[email protected]",
                "url": "http:\/\/www.testoffer.com",
                "title": "Test offer for US customers",
                "description": "Test offer description",
                "currency": "USD",
                "averageRating": 4,
                "active": true,
                "createdAt": 1384260473,
                "updatedAt": 1384260473,
                "price": 10,
                "applicableTaxRate": "0.21",
                "tags": [],
                "period": "24",
                "contentExternalId": 0,
                "contentExternalData": null
            }, {
                "id": "P841924054_FR",
                "publisherEmail": "[email protected]",
                "url": "http:\/\/testoffer.com\/fr",
                "title": "Test offer for French customers",
                "description": "Test offer description",
                "currency": "EUR",
                "averageRating": 4,
                "active": true,
                "createdAt": 1384260473,
                "updatedAt": 1384260473,
                "price": 8,
                "applicableTaxRate": "0.21",
                "tags": [],
                "period": "24",
                "contentExternalId": 0,
                "contentExternalData": null
            }]
        },
        "id": "1",
        "error": null,
        "jsonrpc": "2.0"
}