Live Push User Redemption

Request Details

Item Value
Description Sends information about redemption events for a member to a client specified endpoint.
Method POST
Endpoint Client provided, must begin with https://
Content Type application/json

Recommended Request Authentication

Field Name Sample Value Required Format Description
Basic

Username: test

Password: password123

Base64Auth

No String

Basic auth is the client provided username & password in Base 64 format.

The value of username:password is Base64 encoded.

x-api-key GRscvhg53SsDg1gxxsDgcsf123 No String x-api-key is the client provided API key for access to the defined endpoint

Multilanguage Support

  • The member’s preferred language (stored on their profile) is what determines the language of the provided values. This value is set via User Create API, User Update API or via widget.
  • The translated fields (translatedTitle, translatedDescription) will be null if either the user’s language is not set or if translations for the associated activity are not loaded into the CrowdTwist platform.

Request Body


Field Name Sample Value Required Format Description
orderId 101 Y Integer Unique order ID of the redemption
orderDate 1438043367 Y Timestamp Date the redemption was performed (unix timestamp)
rewardId 947563 Y Integer Id of the unique reward. When a reward has multiple sizes/colors, each will have a unique rewardId.
rewardGroupId 12345 Y Integer Group the reward is in. When a reward has multiple sizes/colors, they will all share the same rewardGroupId.
category Gift Cards N String (50) Category of the reward.
title $20 Gift Card Y String (100) The title of the reward.
description $20 to use on our site Y String (3000) Description of the reward.
color null N String (50) Reward color.
size null N String (50) Reward size.
referenceId null N String (50) The reward reference ID
rewardExtraData null N String (4000) Extra data stored within the reward configuration. Limited to 4,000 characters, if longer will be trimmed to 3997 and appended with “…”
userId 6566 Y Integer Internal CrowdTwist member user_id
emailAddress johndoe@gmail.com Y String (200) User’s email address
thirdPartyId null N String (100) User’s third party ID
userName johndoe23 Y String (100) User’s username
firstName John Y String (50) User's first name
lastName Lim Y String (50) User's last name
mobileNumber 2122122112 N String (30) User's phone number
totalPointsRedeemed 10 Y Integer Total points redeemed by user for reward
redeemablePoints 2000 Y Integer Members balance after redemption
quantity 1 Y Integer Number of reward redeemed
couponCode 111122223333 N String (1000) If code reward – array of codes distributed for redemption
shippingFirstName null N String (50) If required by reward – first name to whom the reward will be shipped
shippingLastName null N String (50) If required by reward – last name to whom the reward will be shipped
shippingStreetAddress1 null N String (100) If required by reward – street address of destination the reward will be shipped
shippingStreetAddress2 null N String (100) If required by reward – additional address info of destination the reward will be shipped
shippingCountry null N String (100) If required by reward – country of destination the reward will be shipped
shippingState null N String (50) If required by reward – state of destination the reward will be shipped
shippingCity null N String (100) If required by reward – city of destination the reward will be shipped
shippingPostalCode null N String (25) If required by reward – zip code of destination the reward will be shipped
shippingPhoneNumber null N String (30) If required by reward – phone number of user redeeming reward
notes null N String (4000) Limited to 4,000 characters, if longer will be trimmed to 3997 and appended with “…”
dateFulfilled null N Timestamp Date reward fulfilled
trackingNumber null N String (30) If physical reward – Tracking number of shipment
redemptionCustomData {\”key\”:\”value\”} N String (4000) Extra data unique to the specific. Limited to 4,000 characters, if longer will be trimmed to 3997 and appended with “…”
languageId es N String (6) Preferred language for the member
translatedTitle Tarjeta de regalo de $ 20 N String (100) Title of the reward redeemed, in the member’s preferred language (relative to languageId)
translatedDescription $ 20 para usar en nuestro sitio N String (3000) Description of the reward redeemed, in the member’s preferred language (relative to languageId)
translatedSize null N String (50) Size of the reward redeemed, in the member’s preferred language (relative to languageId)
translatedColor null N String (50) Color of the reward redeemed, in the member’s preferred language (relative to languageId)



Sample Request


{
   "category":"Basic (EjIWt)",
   "color":"Red",
   "couponCode":"July2020",
   "dateFulfilled":null,
   "description":"Awesome coupon",
   "emailAddress":"johnsmith@gmail.com",
   "firstName":"John",
   "languageId":"fr",
   "lastName":"Smith",
   "mobileNumber":"76565756758",
   "notes":"coupon",
   "orderDate":"1541438256",
   "orderId":2,
   "quantity":1,
   "redeemablePoints":5190,
   "referenceId":null,
   "rewardExtraData":null,
   "rewardGroupId":"412",
   "rewardId":565768,
   "shippingCity":"New York",
   "shippingCountry":"US",
   "shippingFirstName":"John",
   "shippingLastName":"Smith",
   "shippingPhoneNumber":"4958394593",
   "shippingPostalCode":"10010",
   "shippingState":"NY",
   "shippingStreetAddress1":"110 E 2rd st",
   "shippingStreetAddress2":null,
   "size":"Large",
   "thirdPartyId":null,
   "title":"cheap coupon",
   "totalPointsRedeemed":80,
   "trackingNumber":null,
   "translatedColor":"Rouge",
   "translatedDescription":"Super coupon",
   "translatedSize":"grand",
   "translatedTitle":"coupon pas cher",
   "userId":203,
   "userName":"pranaypatil11",
   "redemptionCustomData":[
      {
         "modelNumber":" A56758",
         "carType":"Sedan"
      }
   ]
}