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://


Request Body

Field Name Sample Value Required Format Description
orderDate 1438043367 Y Timestamp Date the redemption was performed (unix timestamp)
orderId 101 Y Number Unique order ID of the redemption
shippingFirstName null N String If required by reward – first name to whom the reward will be shipped
shippingLastName null N String If required by reward – last name to whom the reward will be shipped
shippingStreetAddress1 null N String If required by reward – street address of destination the reward will be shipped
shippingStreetAddress2 null N String If required by reward – additional address info of destination the reward will be shipped
shippingCountry null N String If required by reward – country of destination the reward will be shipped
shippingState null N String If required by reward – state of destination the reward will be shipped
shippingCity null N String If required by reward – city of destination the reward will be shipped
shippingPostalCode null N String If required by reward – zip code of destination the reward will be shipped
shippingPhoneNumber null N String If required by reward – phone number of user redeeming reward
emailAddress johndoe@gmail.com Y String User’s email address
redeemablePoints 2000 Y Number Total points redeemed by user for reward
quantity 1 Y String Number of reward redeemed
category Reward Category N String Category of the reward redeemed
rewardTitle Reward Title Y String The title of the reward
color null N String Reward Color
size null N String Reward Size
couponCode null N String If code reward – array of codes distributed for redemption
notes Reward Notes N String Any notes relating to the user’s redemption
thirdPartyId null N String User’s third party ID
referenceId null N String The reward reference ID
firstName John Y String User’s first name
lastName Lim Y String User’s last name
userName johndoe23 Y String User’s username
dateFulfilled null N Timestamp Date reward fulfilled
trackingNumber null N String If physical reward – Tracking number of shipment
totalPointsRedeemed 10 Y Number Total points redeemed by user for reward
userId 6566 Y Number Internal CrowdTwist member user_id


Sample Request

{
  "totalPointsRedeemed": 10,
  "shippingCity": null,
  "lastName": "Lim",
  "notes": "Reward Notes",
  "color": null,
  "orderId": 101,
  "redeemablePoints": 2000,
  "rewardTitle": "Reward Title",
  "shippingStreetAddress1": null,
  "shippingStreetAddress2": null,
  "shippingPostalCode": null,
  "referenceId": null,
  "thirdPartyId": null,
  "emailAddress": "johndoe@gmail.com",
  "shippingCountry": null,
  "shippingPhoneNumber": null,
  "trackingNumber": null,
  "quantity": 1,
  "shippingLastName": null,
  "userName": "johndoe23",
  "firstName": "John",
  "dateFulfilled": null,
  "size": null,
  "shippingFirstName": null,
  "shippingState": null,
  "category": "Reward Category",
  "orderDate": "1438043367",
  "couponCode": null
}
{
  "totalPointsRedeemed": 10,
  "shippingCity": null,
  "lastName": "Lim",
  "notes": "Reward Notes",
  "color": null,
  "orderId": 101,
  "redeemablePoints": 2000,
  "rewardTitle": "Reward Title",
  "shippingStreetAddress1": null,
  "shippingStreetAddress2": null,
  "shippingPostalCode": null,
  "referenceId": null,
  "thirdPartyId": null,
  "emailAddress": "johndoe@gmail.com",
  "shippingCountry": null,
  "shippingPhoneNumber": null,
  "trackingNumber": null,
  "quantity": 1,
  "shippingLastName": null,
  "userName": "johndoe23",
  "firstName": "John",
  "dateFulfilled": null,
  "size": null,
  "shippingFirstName": null,
  "shippingState": null,
  "category": "Reward Category",
  "orderDate": "1438043367",
  "couponCode": null
}