Redemptions

Retrieve redemption history, if any, for a given program membership.

get

Invoke this endpoint to return an array of rewards that were redeemed while associated with a specified program membership.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

program_membership_idstringRequired

the program membership id

Responses

200

OK

application/json

get

/v2/program-memberships/{program_membership_id}/redemptions

HTTPcURLJavaScriptPython

GET /partner-api/v2/program-memberships/{program_membership_id}/redemptions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK

{
  "redemptions": [
    {
      "date": 1,
      "description": "text",
      "code": "text"
    }
  ]
}

Generate a redemption code for a given reward by providing the program_membership_id and reward_id.

post

Utilize this endpoint to generate a redemption code for a given reward.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

program_membership_idstringRequired

the program membership id

Body

application/x-www-form-urlencoded

reward_idstringRequired

the reward uuid

Responses

200

OK

application/json

404

Could not generate code due to invalid program_membership_id or reward_id.

post

/v2/program-memberships/{program_membership_id}/redemptions

HTTPcURLJavaScriptPython

POST /partner-api/v2/program-memberships/{program_membership_id}/redemptions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20

"reward_id='text'"

{
  "redemption": {
    "uuid": "text",
    "code": "text",
    "promo_code": "text",
    "state": "text",
    "expires_at": 1
  }
}