POST v1/Companies({CompanyId})/Entities({LocationId})/Rewards

Creates a Loyalty Reward for a Location at a Company

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	The unique Company Id that was provided in your onboarding package	integer	Required
LocationId	The Location where you want to create the Loyalty Reward. Can be the Company Id if you want this reward available company-wide	integer	Required

Body Parameters

Body of call see example above

LoyaltyRewardPost

Name	Description	Type	Additional information
PointsRequired	The points required to redeedm this reward.	integer	None.
Name	The name of this reward	string	None.
Value	The dollar value of this reward.	string	None.
Type	The type of reward. The must be 'MoneyOffInvoice'.	RewardType	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "$5 off for 5000",
  "PointsRequired": 5000,
  "Type": "MoneyOffInvoice",
  "Value": "5"
}

Response Information

Resource Description

Loyalty Reward that was created for the specified Location in a Company

LoyaltyRewardsByCompanyReturn

Name	Description	Type	Additional information
Id	The unique Id for this reward. This is generated by the system and is required for updating or deleting a reward, but not for creating a reward.	integer	None.
Name	The name of this reward.	string	None.
PointsRequired	The points required to redeedm this reward.	integer	None.
Type	The type of reward. The must be 'MoneyOffInvoice'.	RewardType	None.
Value	The dollar value of this reward.	string	None.
DiscountId	The corresponding DisocuntId for this reward. Is not used	globally unique identifier	None.
LastModifiedUtc	The last modified date of this reward.	date	None.
LastModifiedUserName	The username of the last user to modify this reward.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 310,
  "Name": "$5 off for 5000",
  "PointsRequired": 5000,
  "Type": "MoneyOffInvoice",
  "Value": "5",
  "DiscountId": "565ecf0d-3d0b-47f2-a741-ae6b5eb6104d",
  "LastModifiedUtc": "2018-06-29T22:58:23.6588214Z",
  "LastModifiedUserName": "Simon Jacobs"
}