For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Get supportSee a Demo
HomeAPI ReferenceSDKs
HomeAPI ReferenceSDKs
    • SDKs
    • WebView
  • API Reference
      • POSTCreate Attribution Events
      • POSTActivate Offer
      • POSTBoost Offer
      • POSTActivate Placement Slot
Get supportSee a Demo
API ReferenceAttributions

Activate Offer

POST
/v2/issuers/:organizationId/users/:userId/offers/:offerId/activate
POST
/v2/issuers/:organizationId/users/:userId/offers/:offerId/activate
$curl -X POST https://rewards-api.getkard.com/v2/issuers/organization-123/users/user-123/offers/offer-456/activate \
>     -H "Authorization: Bearer <token>"
1{
2  "data": {
3    "type": "offerAttribution",
4    "id": "c94a93a7-beb9-4e58-960c-2c812f849398",
5    "attributes": {
6      "entityId": "offer-456",
7      "eventCode": "ACTIVATE",
8      "medium": "CTA",
9      "eventDate": "2025-01-01T00:00:00Z"
10    }
11  }
12}

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.

Was this page helpful?
Previous

Boost Offer

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired
Your issuer organization ID, provided by Kard
userIdstringRequired
The ID of the user as defined on the issuers system
offerIdstringRequired
The unique identifier of the offer being activated

Query parameters

supportedComponentsenumOptional

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

includeenumOptional

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

Allowed values:

Response

This endpoint returns an object.
dataobject
includedlist of objects

Errors

400
Invalid Request
401
Unauthorized Error
500
Internal Server Error