PATCH api/rewards/rewardinfo

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RewardKey	string	None.
RewardName	string	Required
RewardDescription	string	Required
RewardTOS	string	None.
RewardEffectiveFrom	date	Required
RewardEffectiveTo	date	None.
RewardPayoutType	string	None.
RewardCreationType	integer	None.
RewardCreationReferenceId	string	None.
RewardDistributionType	string	None.
RewardTotalReward	integer	None.
RewardPayfectSKU	string	None.
RewardAutoPay	boolean	None.
ConnectLeaderBoard	boolean	None.
LeaderBoardKey	string	None.
PayOutDay	integer	None.
RewardStatus	integer	None.
CreatedOn	date	None.
CreatedBy	string	None.
ModifiedOn	date	None.
ModifiedBy	string	None.
RewardParticipantUserType	string	None.
RewardEligibility	Collection of RewardEligibility	None.
RewardEvents	Collection of RewardEvents	Required
RewardParticipants	Collection of RewardParticipants	Required
NotificationConfig	NotificationConfigWrapper	None.

Request Formats

application/json, text/json

Sample:

{
  "RewardKey": "sample string 1",
  "RewardName": "sample string 2",
  "RewardDescription": "sample string 3",
  "RewardTOS": "sample string 4",
  "RewardEffectiveFrom": "2026-04-07T07:02:24.3208427+00:00",
  "RewardEffectiveTo": "2026-04-07T07:02:24.3208427+00:00",
  "RewardPayoutType": "sample string 5",
  "RewardCreationType": 6,
  "RewardCreationReferenceId": "sample string 7",
  "RewardDistributionType": "sample string 8",
  "RewardTotalReward": 9,
  "RewardPayfectSKU": "sample string 10",
  "RewardAutoPay": true,
  "ConnectLeaderBoard": true,
  "LeaderBoardKey": "sample string 13",
  "PayOutDay": 14,
  "RewardStatus": 15,
  "CreatedOn": "2026-04-07T07:02:24.3208427+00:00",
  "CreatedBy": "sample string 16",
  "ModifiedOn": "2026-04-07T07:02:24.3208427+00:00",
  "ModifiedBy": "sample string 17",
  "RewardParticipantUserType": "sample string 18",
  "RewardEligibility": [
    {
      "EligibilityType": 1,
      "EligibilityValue": "sample string 1",
      "CreatedOn": "2026-04-07T07:02:24.3208427+00:00",
      "CreatedBy": "sample string 3",
      "ModifiedOn": "2026-04-07T07:02:24.3208427+00:00",
      "ModifiedBy": "sample string 4"
    },
    {
      "EligibilityType": 1,
      "EligibilityValue": "sample string 1",
      "CreatedOn": "2026-04-07T07:02:24.3208427+00:00",
      "CreatedBy": "sample string 3",
      "ModifiedOn": "2026-04-07T07:02:24.3208427+00:00",
      "ModifiedBy": "sample string 4"
    }
  ],
  "RewardEvents": [
    {
      "EventKey": "sample string 1",
      "ValueType": 1,
      "Value": 1.0,
      "Status": 1,
      "CreatedOn": "2026-04-07T07:02:24.3208427+00:00",
      "CreatedBy": "sample string 3",
      "ModifiedOn": "2026-04-07T07:02:24.3208427+00:00",
      "ModifiedBy": "sample string 4"
    },
    {
      "EventKey": "sample string 1",
      "ValueType": 1,
      "Value": 1.0,
      "Status": 1,
      "CreatedOn": "2026-04-07T07:02:24.3208427+00:00",
      "CreatedBy": "sample string 3",
      "ModifiedOn": "2026-04-07T07:02:24.3208427+00:00",
      "ModifiedBy": "sample string 4"
    }
  ],
  "RewardParticipants": [
    {
      "ContactId": "sample string 1",
      "Status": 1,
      "AccountId": "sample string 2",
      "RewardUserType": 1,
      "CreatedOn": "2026-04-07T07:02:24.3208427+00:00",
      "CreatedBy": "sample string 3",
      "ModifiedOn": "2026-04-07T07:02:24.3208427+00:00",
      "ModifiedBy": "sample string 4"
    },
    {
      "ContactId": "sample string 1",
      "Status": 1,
      "AccountId": "sample string 2",
      "RewardUserType": 1,
      "CreatedOn": "2026-04-07T07:02:24.3208427+00:00",
      "CreatedBy": "sample string 3",
      "ModifiedOn": "2026-04-07T07:02:24.3208427+00:00",
      "ModifiedBy": "sample string 4"
    }
  ],
  "NotificationConfig": {
    "enabled": true,
    "config": {
      "configKey": "sample string 1",
      "frequencyType": "sample string 2",
      "dayOfWeek": 1,
      "dayOfMonth": 1,
      "notificationDayOffset": 1,
      "recipientType": "sample string 3",
      "templateCount": 4,
      "templateAssignments": {},
      "sendEmail": true,
      "sendSMS": true,
      "reviewCheckPeriodDays": 8
    },
    "configs": [
      {
        "configKey": "sample string 1",
        "frequencyType": "sample string 2",
        "dayOfWeek": 1,
        "dayOfMonth": 1,
        "notificationDayOffset": 1,
        "recipientType": "sample string 3",
        "templateCount": 4,
        "templateAssignments": {},
        "sendEmail": true,
        "sendSMS": true,
        "reviewCheckPeriodDays": 8
      },
      {
        "configKey": "sample string 1",
        "frequencyType": "sample string 2",
        "dayOfWeek": 1,
        "dayOfMonth": 1,
        "notificationDayOffset": 1,
        "recipientType": "sample string 3",
        "templateCount": 4,
        "templateAssignments": {},
        "sendEmail": true,
        "sendSMS": true,
        "reviewCheckPeriodDays": 8
      }
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.