Update an offer

patch

https://api.sandbox.cleeng.com/3.1/offers/{offerId}

Use this endpoint to update offers. It updates specific fields of an existing offer.
This endpoint supports conditional requests.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

offerId

string

required

Cleeng offer ID in a short format (without a country suffix). The unique identifier of the offer to be updated.

Body Params

title

string

Offer title, up to 255 characters.

description

string

Offer description, up to 255 characters. Example: Best deal!

tags

url

string

Url to your content described in the offer. Up to 200 characters. Example: https://example.com

imageUrl

string

Url to an image for an offer. Up to 255 characters. Example: https://example.com/image.jpg

price

object

Offer price. The offer price may be equal to zero. If it is above zero, it must be higher than the set minimum price (the minimum price differs per offer type and currency). If you decide to update an offer price, the amount or rules is required. You cannot change the currency of an offer.

entitlement

object

The parameter applies to 'pass' and 'vod' offer types. Either expiresAt or duration is used depending on the offer type.

event

object

The parameter for 'live' offer type.

freeTrial

object

Used only in 'subscription' offer type.

externalProperties

object

Object with string values. This field can be null. If you want to update, you need to provide the whole object, and the whole object is replaced. Example: OrderedMap { "custom-attribute": "custom value" }

appStoreProductIds

object

ID of an offer in a given App store. If you decide to change appStoreProductId for one store, you need to repeat the unchanged ones for other stores.

seasonGroupId

string

Available only for seasonal offers. Format: UUID. This is the identifier of a seasonal schedule - a group of seasons, each with its start and end date defined. (For more information on seasonal schedules, see Seasonal subscriptions.) Example: 0bdb7589-762c-40bf-b501-a0f02b59d76d

giftable

boolean

Whether an offer can be purchased as a gift.

geoRestriction

object

geoRestriction might be object or null (when disabled). If geoRestriction is an object, then type or countries are required. If you want to update geoRestriction, and you only change type, countries will remain unchanged (if you only change countries, type will remain unchanged ).

Responses

200

400Bad Request

404Not Found

422Unprocessable Entity