users > attributions

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

post/v2/issuers/{organizationId}/users/{userId}/offers/{offerId}/activate

Request

  • Base URL
    https://rewards-api.getkard.com
  • URL
    https://rewards-api.getkard.com/v2/issuers/{organizationId}/users/{userId}/offers/{offerId}/activate
  • 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 activated

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 activate offer response

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

Response

Response with status 201

Changes

    • info

      added the non-success response with the status

    • info

      added the optional property ////// to the response with the status