users > attributions

Boost Offer

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.

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

Path parameters

organizationIdstring required

Your issuer organization ID, provided by Kard

userIdstring required

The ID of the user as defined on the issuers system

offerIdstring required

The unique identifier of the offer being boosted

Query parameters

supportedComponents'shortDescription' | 'longDescription' | 'baseReward' | 'boostedReward' | 'cta' | 'tags' | 'detailTags' | 'logoFlare' | 'progressBar'

Available UI component types for offers

UI component types to include in the offer response (when include=offer).

include'offer'

Options for what to include in the boost offer response

Related resources to include in the response. Allowed value is offer.

Response

Response with status 201

Changes

No recorded changes to this operation across all 1 revision of this API.