Skip to main content
POST
Create a claim link
Retrieve a claim link for a successfully fulfilled redemption. Send no request body. Use this endpoint when the initial redemption response has no link, when an order completes later, or when a participant returns to access their card. Redemption GET/list responses and webhooks do not include links. The returned URL can be the same as an earlier link, and creating a link does not guarantee that earlier links become invalid. expires_at appears only when the fulfillment account reports a link expiry.
See Deliver the claim link for the participant’s flow. Always retrieve a missing link for the existing redemption to avoid ordering a second card.

Errors

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Redemption ID

Response

Usable claim link

claim_url
string

URL the participant can use to access the fulfilled reward

Example:

"https://claim.example.com/abc123"

expires_at
string<date-time>

Link expiry, present only when the provider reports one

Example:

"2024-01-15T11:30:00Z"

provider
string

Fulfillment provider name

Example:

"TREMENDOUS"

status
enum<string>

Fulfillment lifecycle status (always SUCCEEDED on a 200 response)

Available options:
SUCCEEDED
Example:

"SUCCEEDED"