PUT v1/Companies({CompanyId})/Entities({LocationId})/Rewards({RewardId})
Deletes and Creates a Loyalty Reward
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId |
The unique Company Id that was provided in your onboarding package |
integer |
Required |
| LocationId |
Any Location Id, or the Company Id |
integer |
Required |
| RewardId |
The unique Reward Id you want to update. This Reward will be deleted and a new one created with a new Id |
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. This 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
None.