Send a reward

Sends a FIXED reward (a specific gift card) or a CHOICE reward (the recipient picks cards up to the value). The recipient receives a branded email with a redemption link. Supply an Idempotency-Key header to make retries safe.

Authorization

apiKey

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*string

Value in

"FIXED"
"CHOICE"

valueCents*integer

Range0 < value <= 500000

currency?string

Length3 <= length <= 3

Default"USD"

recipient*

message?string

Lengthlength <= 1000

utid?string

Match^[uU]\d+$

allowedBrandKeys?array<string>

Itemsitems <= 200

campaign?string

Lengthlength <= 255

externalId?string

Lengthlength <= 100

expiresAt?string

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/v1/rewards" \  -H "Content-Type: application/json" \  -d '{    "type": "FIXED",    "valueCents": 1,    "recipient": {      "email": "user@example.com",      "firstName": "string"    }  }'

{  "reward": {    "id": "string",    "type": "FIXED",    "status": "string",    "faceValueCents": 0,    "remainingValueCents": 0,    "currency": "string",    "recipientEmail": "string",    "recipientFirstName": "string",    "recipientLastName": "string",    "message": "string",    "utid": "string",    "allowedBrandKeys": [      "string"    ],    "campaign": "string",    "externalId": "string",    "source": "string",    "expiresAt": "string",    "sentAt": "string",    "openedAt": "string",    "redeemedAt": "string",    "createdAt": "string",    "brandName": "string",    "brandImageUrl": "string",    "issuedCards": [      {        "id": "string",        "utid": "string",        "rewardName": "string",        "amountCents": 0,        "currency": "string",        "status": "string",        "redemptionInstructions": "string",        "issuedAt": "string",        "createdAt": "string",        "brandName": "string",        "brandImageUrl": "string",        "credentials": [          {            "label": "string",            "value": "string",            "type": "string"          }        ]      }    ],    "events": [      {        "id": "string",        "type": "string",        "metadata": {          "property1": null,          "property2": null        },        "createdAt": "string"      }    ]  },  "redemptionUrl": "string"}

Authorization

Request Body

Response Body

200application/json

201application/json

402application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`