updateMultiCurrencyRentalOffer

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

Name

Type

Description

publisherToken*

string

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

multiCurrencyOfferId*

string

E.g. if you create multicurrency offer and you get couple of ids: A767351455_FR, A767351455_US, A767351455_GB. multiCurrencyOfferId is just A767351455

offerData

object

No description

-price

float

Offer price (in publisher's currency), value between 0.14 and 99.99

-title

string

Title of the offer, up to 70 chars.

-period

integer

Amount of time after which purchase will expire (in hours)

-url

string

Url to content

-description

string

Additional offer description, up to 110 chars

-tags

string

Tags attached to offer.

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

-videoId

string

Link offer with unique video asset id

-contentExternalId

string

This parameter is for your own usage. You can put here id of article or video, anything what can make your offer clearer for you.

-contentExternalData

string

If you want to store a few extra elements related to the sale you can use this string to store additional data.

-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":"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"
}