> For the complete documentation index, see [llms.txt](https://docs.sparkloop.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sparkloop.app/client-api/objects/offer.md).

# Offer

A sponsored offer your reader can claim. Returned by the [Offers methods](/client-api/offers.md).

| Field                 | Type    | Description                                                                                                                                                   |
| --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `uuid`                | string  | Unique identifier of the offer. Pass it back in `claim`.                                                                                                      |
| `headline`            | string  | Headline of the offer.                                                                                                                                        |
| `description`         | string  | Description of the offer.                                                                                                                                     |
| `callout`             | string  | Short callout text highlighting the offer.                                                                                                                    |
| `call_to_action`      | string  | Text for the offer's call-to-action button.                                                                                                                   |
| `conversion_type`     | string  | `lead`, `click` or `action`. Determines how the offer is claimed — see below.                                                                                 |
| `brand_name`          | string  | Name of the brand behind the offer.                                                                                                                           |
| `brand_logo`          | string  | URL of the brand's logo.                                                                                                                                      |
| `landscape_image_url` | string  | URL of the offer's landscape creative.                                                                                                                        |
| `portrait_image_url`  | string  | URL of the offer's portrait creative.                                                                                                                         |
| `redirect_url`        | string  | Only present on `click` and `action` offers. URL to send the reader to when they claim the offer. Lead offers don't include it.                               |
| `recommendable`       | boolean | Only present when fetching an individual offer. `true` while the offer can still be claimed. When `false`, don't display it — claims to it will be discarded. |

### Conversion types

* **`lead`** — the reader claims the offer with their email address. No redirect involved.
* **`click`** — the reader claims the offer by clicking through to the offer's page via `redirect_url`.
* **`action`** — like `click`, but the reader converts by completing an action on the offer's page after the redirect.

### Example

```json
{
  "uuid": "offer_recommendation_9f8e7d6c5b4a",
  "headline": "Try Acme for free",
  "description": "The all-in-one toolkit for newsletter operators.",
  "callout": "Limited time",
  "call_to_action": "Claim your free trial",
  "conversion_type": "click",
  "brand_name": "Acme",
  "brand_logo": "https://dash.sparkloop.app/rails/active_storage/representations/.../logo.png",
  "landscape_image_url": "https://dash.sparkloop.app/rails/active_storage/representations/.../landscape.png",
  "portrait_image_url": "https://dash.sparkloop.app/rails/active_storage/representations/.../portrait.png",
  "redirect_url": "https://offer.example.com/?..."
}
```