Offers

Update offer

Updates offer

put/offers/{id}

Request

  • Base URL: https://admin-api.docs.keitaro.io/admin_api/v1
  • URL: https://admin-api.docs.keitaro.io/admin_api/v1/offers/{id}
  • Auth: API key in header Api-Key

Path parameters

idinteger required

Offer ID

Request body

namestring

Offer name

group_idinteger

Offer group ID

offer_typestring

Offer Type ('local'/'external'/'preloaded'/'action')

action_typestring

Action or redirect type

affiliate_network_idinteger

Affiliate network ID

payout_valuenumber

Payout value

payout_currencystring

Payout currency

payout_type'CPA' | 'CPC'

Payout type

state'active' | 'deleted'

Offer State

payout_autoboolean

If true, offer receives payout value from postback

payout_upsellboolean

Allow offer to get upsells

countrystring[]

Country codes (i.g, ["US", "DE", "JP"])

notesstring

Notes

archivestring

ZIP-file encoded to base64

conversion_cap_enabledboolean

Turn on that feature if the offer limit conversions per day

daily_capnumber

Daily limit of conversions, after which the tracker will send traffic to another offer

conversion_timezonestring

Which timezone is being used by the Affiliate network for calculating conversions, e.g. UTC or Europe/Madrid

alternative_offer_idnumber

Offer id, where to send traffic when daily limit is reached

Response

Offer

idinteger
namestring
group_idinteger
action_typestring
action_optionsobject
affiliate_network_idinteger
payout_valuenumber
payout_currencystring
payout_typestring
statestring
created_atstring
updated_atstring
payout_autoboolean
payout_upsellboolean
countrystring[]
notesstring
affiliate_networkstring
archivestring
local_pathstring
preview_pathstring
valuesobject[]

Example response

{
  "values": [
    {
      "exampleKey": "exampleValue"
    },
    {
      "price": "100"
    },
    {
      "currency": "EUR"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.