RewardCampaignService
Acknowledge My Reward Award
Record revealing an award or seeing a paid award's delivery for the authenticated recipient. Requires a session token. Repeated acknowledgements preserve the first timestamps. Existing awards remain unseen until explicitly acknowledged.
Request
curl --request POST \ \
--url 'https://api.testnet.polyester.com/v1/rewards/awards/7d32e3e0-5bcb-4a09-9184-cd4c8e95bc91/acknowledge' \
--header 'Accept: */*' \
--header 'X-API-KEY-ID: YOUR_API_KEY_ID' \
--header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \
--header 'X-API-SIGNATURE: YOUR_API_SIGNATURE' \
--header 'Content-Type: application/json' \
--data '{
"deliverySeen": true,
"revealed": true
}'Responses
{
"award": {
"amountBaseUnits": "123.45",
"assetId": 100,
"awardId": "value",
"campaignId": "value",
"campaignName": "value",
"deliverySeenAt": "2025-01-01T00:00:00Z",
"destinationAddress": "0x3333333333333333333333333333333333333333",
"fulfillmentMethod": "EXTERNAL_TESTNET",
"fulfillmentRevision": "1",
"fulfillmentState": "AWAITING_DESTINATION",
"network": "value",
"publishedAt": "2025-01-01T00:00:00Z",
"revealedAt": "2025-01-01T00:00:00Z",
"transactionId": "value"
}
}Award owned by the authenticated root account. Must be a UUID.
Record that the recipient saw this award's delivery. Requires a paid award; otherwise the entire request fails with failed_precondition. False leaves the existing mark unchanged.
Record that the recipient revealed this award. False leaves the existing mark unchanged.
Stable opaque award identifier.
valueStable campaign identifier.
valueCampaign display name frozen at publication.
valueCanonical asset identifier.
100Exact integer amount in the asset's smallest base unit.
123.45Selected delivery method.
EXTERNAL_TESTNETCurrent delivery state.
AWAITING_DESTINATIONPublication time.
2025-01-01T00:00:00ZCampaign payout network. Interpret destination_address in this network.
valueCurrent fulfillment revision for optimistic concurrency.
1Recipient payout destination once submitted. Empty until provided.
0x3333333333333333333333333333333333333333External transaction identifier once staff records delivery. Empty until delivered.
valueTime the recipient first acknowledged revealing this award. Absent until explicitly acknowledged; shared across sessions and devices.
2025-01-01T00:00:00ZTime the recipient first acknowledged seeing delivery of this paid award. Absent until explicitly acknowledged; independent of revealed_at.
2025-01-01T00:00:00Z| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |