V1PlatformRewardsIdArchive
Archive a published reward, retaining claims and redemption history
Authorization
bearer AuthorizationBearer <token>
In: header
Path Parameters
id*string
Match
^([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)$Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/platform/rewards/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive" \ -H "Content-Type: application/json" \ -d '{ "expectedVersion": 1, "reason": "string" }'{ "kind": "product", "eligibility": "signup", "signupWithinDays": 30, "benefit": { "type": "free" }, "exclusions": "", "outletIds": [], "catalogItemId": null, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0", "merchantName": "string", "title": "string", "status": "draft", "version": -9007199254740991, "updatedAt": "2019-08-24T14:15:22Z", "stockTotal": -9007199254740991, "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "reviewNote": "string", "definition": { "kind": "product", "eligibility": "signup", "signupWithinDays": 30, "benefit": { "type": "free" }, "exclusions": "", "outletIds": [], "catalogItemId": null, "partnerFunded": true, "title": "string", "summary": "string", "rules": "string", "deliveryKind": "physical_gift", "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "redeemBy": "2019-08-24T14:15:22Z", "timezone": "string", "stockTotal": 1, "reservationTtlSeconds": 60 }, "imageDataUrl": "string"}Review full reward details and sanitized image GET
Previous Page
Admin approves and publishes a submitted offer or requests changes POST
One published signup offer per merchant requires a selected welcome claim policy. General member benefits are independent of that policy. Publication is immutable and immediately visible in the app; requesting changes requires a note.