Skip to main content

Fields

availableSitesUrl : String

The available sites url for this offer.

category : String

The category of the offer.

Describes whether the user should be able to claim this offer, and the reason if not.

claimBy : DateTime

The datetime at which the user should no longer be able to claim this offer.

description : String

The short description of the offer.

The faqs for this offer.

The image urls for this offer.

longDescription : String

The long description of the offer.

name : String

The name of the offer to be displayed to the user.

partnerName : String

The name of the reward partner.

partnerSiteUrl : String

The partner site url for this offer.

pointsCost : Int

The points cost of claiming this offer.

priceTag : String

The price tag for this offer.

slug : String

The slug to be used as the offer identifier.

termsAndConditions : String

The terms and conditions to display to the user.

usageInstructions : String

The instructions for the user as to how to use their claimed reward.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "availableSitesUrl": "time-shake-together-land-say", "category": "establish-economic-foot-few-teacher", "claimAbility": OctoplusRewardClaimAbilityType, "claimBy": "1973-04-17T00:27:03.863673+00:00", "description": "end-same-employee-herself-bring", "faqs": [OctoplusOfferFAQsType], "imageUrls": OctoplusOfferImageUrlsType, "longDescription": "question-behind-subject-me-day", "name": "type-meeting-hospital-time-loss", "partnerName": "can-spring-model-next-such", "partnerSiteUrl": "ok-mind-air-woman-yard", "pointsCost": 96, "priceTag": "church-have-minute-best-generation", "slug": "offer-analysis-spring-prepare-finish", "termsAndConditions": "fear-good-foot-security-may", "usageInstructions": "moment-chance-trial-for-foreign" }