updateMultiCurrencyRentalOffer

❗️

Deprecated

This API endpoint is deprecated. If you would like to create or modify an offer with localization, you can do so directly in the Cleeng dashboard.

Update different offers for different countries using localizedData array. Plase note, that you are unable to edit currency.

📘

You can try that method by clicking here

Parameters

NameTypeDescription
publisherToken*stringYou can find your publisher token at api-keys page.
multiCurrencyOfferId*stringE.g. if you create multicurrency offer and you get couple of ids: A767351455_FR, A767351455_US, A767351455_GB. multiCurrencyOfferId is just A767351455
offerDataobjectNo description
-pricefloatOffer price (in publisher's currency), value between 0.14 and 99.99
-titlestringTitle of the offer, up to 70 chars.
-periodintegerAmount of time after which purchase will expire (in hours)
-urlstringUrl to content
-descriptionstringAdditional offer description, up to 110 chars
-tagsstringTags attached to offer.
localizedDataarray-
-country*string2-letter country code
-currencystringChoose one: USD, EUR, GBP, CAD, AUD, NZD, SEK, DKK, NOK, TRL, ZAR, XOF
-pricefloatvalue between 0.14 and 99.99
-titlestringTitle of the offer, up to 70 chars.
-urlstringUrl to content
-descriptionstringAdditional offer description, up to 110 chars
-videoIdstringLink offer with unique video asset id
-contentExternalIdstringThis parameter is for your own usage. You can put here id of article or video, anything what can make your offer clearer for you.
-contentExternalDatastringIf you want to store a few extra elements related to the sale you can use this string to store additional data.
-geoRestrictionEnabledboolSet "true" to enable geo-restriction on this offer
-geoRestrictionTypestringChoose type of geo-restriction: whitelist / blacklist
-geoRestrictionCountriesarrayBased on geoRestrictionType, set the array of whitelisted/blacklisted countries.

API Request/Response

Request

{
  "method":"updateMultiCurrencyRentalOffer",
  "params":{
    "publisherToken":"klj_nerb324sPLhmzLtp4mDmdc8slwNNyALt-1Xn2Hy0Icfay",
    "multiCurrencyOfferId":"R841924054",
    "offerData":{
      "price":"10",
      "tags":[
       ]
     },
     "localizedData":[
      {
        "country":"US",
        "currency":"USD",
        "price":"11",
        "title":"Test offer for US customers"
       },
       {
        "country":"FR",
        "currency":"EUR",
        "price":"9"
        }
      ] 
    },
    "jsonrpc":"2.0",
    "id":1
}

Response

{
    "result": {
        "multiCurrencyOfferId": "R841924054",
        "offers": [{
            "id": "R841924054_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": 1384265819,
            "price": 11,
            "applicableTaxRate": "0.21",
            "tags": [],
            "period": "24",
            "videoId": "",
            "contentExternalId": "0",
            "contentExternalData": null
        }, {
            "id": "R841924054_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": 1384265820,
            "price": 9,
            "applicableTaxRate": "0.21",
            "tags": [],
            "period": "24",
            "videoId": "",
            "contentExternalId": "0",
            "contentExternalData": null
        }]
    },
    "id": "1",
    "error": null,
    "jsonrpc": "2.0"
}