Claim a configured free benefit or discount voucher as yourself
Reuse claimId on retry. A single-use offer returns the account's one claim, including after expiry; a multi-use offer returns the voucher the account holds now, and issues a new claim (new claimId) only once the previous one is used, expired or cancelled and uses remain (reward_uses_exhausted otherwise). Each claim takes one unit of stock. Expired unfulfilled leases release inventory automatically. Identity-required campaigns fail closed until a verified workflow exists; OCR or icHash never qualifies.
Authorization
bearer In: header
Path Parameters
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/rewards/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/claim" \ -H "Content-Type: application/json" \ -d '{ "claimId": "88057929-7728-4a26-8396-f965dcc8b947", "acceptRules": true }'{ "claim": { "pointsSpent": 0, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf", "deliveryKind": "physical_gift", "status": "reserved", "reservedAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "redeemedAt": "2019-08-24T14:15:22Z" }, "availablePoints": 0}Published signup, free product/service and discount campaigns with your own claim status when signed in GET
Each offer allows usesPerMember claims per account (in total, or per calendar month in Asia/Kuala_Lumpur when usesPeriod is calendar_month); the default is one. usesRemaining is the viewer's uses left and ownClaim is their live voucher, otherwise their latest. No health, step or IC data is required. Nothing is published by default.
Sanitized image of a published reward; draft images are inaccessible GET
Next Page