Offer Object

Example

{
  "uuid": "offer_123abc",
  "name": "MyString",
  "headline": "MyString",
  "description": "MyString",
  "callout": "MyString",
  "redirect_url": "sparkloop.app",
  "conversion_type": "action",
  "visibility": "public",
  "status": "active",
  "created_at": "2025-11-18T09:07:48.559Z",
  "landscape_image_url": "image-url",
  "portrait_image_url": "image-url",
  "geo_restrictions": {"allow_worldwide_referrals": true, "allowed_countries": [], "blocked_countries": []},
  "monthly_budget": 2222.0,
  "cpa": 2.0,
  "conversion_event": "purchase",
  "terms": "MyString"
}

Property	Type	Description
uuid	string	the unique ID of the offer
name	string	the internal name of the offer
headline	string	public title of the offer
description	string	public description of the offer
callout	string	short phrase that should grab attention and pops on the offer's image
redirect_url	string	the URL people are redirected to when they click on the offer link
conversion_type	string	Click/Lead/Action
visibility	string	whether it's an internal offer or partner offer
status	string	the status of the offer
created_at	timestamp	the date the offer was created
landscape_image_url	string	URL to the landscape image
portrait_image_url	integer	URL to the portrait image
geo_restrictions	object	the geo-restrictions applied to this offer. The object includes: allow_worldwide_referrals (boolean) allowed_countries (array) -> which countries are allowed (Alpha-2 ISOCODE) blocked_countries (array) -> which countries are blocked (Alpha-2 ISOCODE)
monthly_budget	float	the total monthly budget in dollars
cpa	float	how much this offer pays per confirmed lead in dollars
conversion_event	string	Defines the action a person must complete for the conversion to become payable (applies only to offers using the Action conversion type)
terms	string	custom terms and conditions of the brand (available only for offers of "Action" conversion_type)