Reward - Assign

Assigns a reward configuration to one or more players.

POST /api/v1/integration/rewards/assign

---

Request

Parameter	Type	Description	Required
rewardConfigurationId	UUID	Reward configuration identifier	Conditional
externalRewardConfigurationId	String	Merchant-defined reward configuration identifier	Conditional
playerIds	List<String>	List of Player identifiers	Yes
scheduledStartDate	Long	Scheduled start date in epoch milliseconds	No
externalId	String	Merchant-defined identifier for the assigned reward	No
merchantId	UUID	Merchant identifier	Yes
timestamp	Long	UNIX timestamp in milliseconds	Yes
hash	String	HMAC SHA256 signature used to verify the request	Yes

Example Request

{
  "rewardConfigurationId": "7a899322-c001-4187-8a8b-26d51d0e08fd",
  "playerIds": ["f72cb8ef-10e6-4903-8735-369f6544a0a2"],
  "scheduledStartDate": 1754495931035,
  "externalId": "reward-001",
  "merchantId": "1387a6cc-3651-4473-ae52-e415caea3395",
  "timestamp": 1754495931035,
  "hash": "e93556d37a8c4eab7bda2d411322cdc4f0dc444c9101d9453a6635dfd8c73f7d"
}

---

Response

201 Created

note

The following fields are generated by the platform:

• id — Player reward identifier
• expirationDate — timestamp in epoch milliseconds when the reward expires

Example Response

[
  {
    "id": "6d181739-a4c4-4932-a3de-0a980bfee707",
    "playerId": "f72cb8ef-10e6-4903-8735-369f6544a0a2",
    "expirationDate": 1754582449050
  }
]