---
title: "Boost Offer"
method: POST
path: "/v2/issuers/{organizationId}/users/{userId}/offers/{offerId}/boost"
tags: ["users > attributions"]
---

# Boost Offer

`POST /v2/issuers/{organizationId}/users/{userId}/offers/{offerId}/boost`

## Request

- Base URL: `https://rewards-api.getkard.com`
- URL: `https://rewards-api.getkard.com/v2/issuers/{organizationId}/users/{userId}/offers/{offerId}/boost`
- Auth: HTTP bearer

Record when a user boosts an offer. Creates an attribution event with eventCode=BOOST and medium=CTA.
Optionally include the offer data by passing `include=offer`.

## Path parameters

- `organizationId` string, required: Your issuer organization ID, provided by Kard
- `userId` string, required: The ID of the user as defined on the issuers system
- `offerId` string, required

## Query parameters

- `supportedComponents` 'shortDescription' | 'longDescription' | 'baseReward' | 'boostedReward' | 'cta' | 'tags' | 'detailTags' | 'logoFlare' | 'progressBar': Available UI component types for offers
- `include` 'offer': Options for what to include in the boost offer response

## Response `201`

Response with status 201

- UsersAttributionsBoostOfferResponse
  - `data` UsersAttributionsBoostOfferResponseData, required
    - `type` string, required
    - `id` string, required
    - `attributes` UsersAttributionsBoostOfferResponseAttributes, required
      - `entityId` string, required
      - `eventCode` string, required
      - `medium` string, required
      - `eventDate` string, date-time, required
  - `included` UsersAttributionsBoostOfferIncluded[]
    - union
      - UsersRewardsOfferDataUnion
        - `type` 'standardOffer', required: Discriminator value: standardOffer
        - `id` string, required: The unique identifier for a document in the database
        - `attributes` UsersRewardsStandardOfferFields, required
          - `terms` string, required: Terms and conditions on offer
          - `maxRedemptions` integer: Maximum times cardholder can redeem offer, if applicable
          - `name` string, required: Name of offer
          - `purchaseChannel` CommonsPurchaseChannel[], required
          - `userReward` UsersRewardsCommission, required
            - `type` 'FLAT' | 'PERCENT', required: Type of commission on offer (% or a flat $)
            - `value` number, double, required
          - `assets` UsersRewardsAsset[], required: Assets associated with offer
            - `type` string, required: What the asset shows. `IMG_VIEW` is the merchant logo, `BANNER_VIEW` a promotional banner, and `LOCATION_IMG_VIEW` a photo of the location. New values may be added over time.
            - `url` string, required: URL of the asset containing an attribution token
            - `alt` string, required: Alt text of the asset
          - `startDate` string, date-time, required: Beginning date of offer (UTC)
          - `expirationDate` string, date-time, required: Expiration date of offer if applicable (UTC)
          - `isTargeted` boolean, required: True returns only targeted offers, false returns only non-targeted offers
          - `minTransactionAmount` UsersRewardsAmount
            - `type` 'CENTS', required
            - `value` integer, required
          - `maxTransactionAmount` UsersRewardsAmount
            - `type` 'CENTS', required
            - `value` integer, required
          - `minRewardAmount` UsersRewardsAmount
            - `type` 'CENTS', required
            - `value` integer, required
          - `maxRewardAmount` UsersRewardsAmount
            - `type` 'CENTS', required
            - `value` integer, required
          - `websiteUrl` string: URL to the website of the offer provider
          - `description` string: Description of the offer
          - `components` CommonsOfferComponents: UI component data for rendering offer details
            - `shortDescription` string: Short description for the offer
            - `longDescription` string: Long description for the offer
            - `baseReward` string: Formatted reward string
            - `boostedReward` string: Formatted boosted reward string
            - `cta` CommonsCtaComponent: Call-to-action button component for offers
              - …
            - `tags` string[]: Tags for the offer
            - `detailTags` string[]: Detail tags for the offer
            - `logoFlare` CommonsLogoFlare: Logo flare configuration for offer display
              - …
            - `progressBar` CommonsProgressBar: Progress bar component for tracking offer redemption progress
              - …
        - `relationships` UsersRewardsEligibilityOfferRelationship
          - `category` UsersRewardsCategoryRelationship, required
            - `data` UsersRewardsCategoryData[], required
              - …
          - `locations` CommonsRelationshipMultiple
            - `data` CommonsRelationshipData[], required
              - …
      - UsersRewardsCategoryIncluded
        - `id` string, required: id of the category
        - `type` 'category', required
        - `attributes` UsersRewardsCategoryFields, required
          - `name` 'Arts & Entertainment' | 'Baby, Kids & Toys' | 'Books & Digital Media' | 'Clothing, Shoes & Accessories' | 'Computers, Electronics & Software' | 'Convenience' | 'Gas' | 'Department Stores' | 'Food & Beverage' | 'Health & Beauty' | 'Home & Garden' | 'Miscellaneous' | 'Occasions & Gifts' | 'Pets' | 'Sports & Outdoors' | 'Supplies & Services' | 'Travel', required: Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)

## Other responses

- `400`: Error response with status 400
- `401`: Error response with status 401
- `429`: The issuer's traffic grew faster than its allowed rate, or the endpoint's own limit was reached. If the response includes a `Retry-After` header, wait that many seconds before retrying. See [Rate Limits](/2024-10-01/api/integration-guides/rate-limits).
- `500`: Error response with status 500

## Changes

- **2026-10-22** `4e87fc8b018b`: 2 info
  - added the non-success response with the status `429`
  - added the optional property `included/items/oneOf[subschema #1: OfferDataUnion]/oneOf[subschema #1]/relationships/oneOf[subschema #1: CategoryRelationshipObject]/locations` to the response with the `201` status

[Operation history](https://skmtc.dev/getkard/apis/getkard-2/changes/v2/issuers/:organizationId/users/:userId/offers/:offerId/boost/post.md)

---

[API](https://skmtc.dev/getkard/apis/getkard-2.md) - [All operations](https://skmtc.dev/getkard/apis/getkard-2/llms.txt) - [OpenAPI document](https://skmtc.dev/getkard/apis/getkard-2/revisions/bd47764afa21?raw)