Reward Enrollments¶

Enrollments link specific players to rewards. Once a player is enrolled, they can consume the reward (e.g. use their free bets) within the configured time window and on the specified products.

For authentication details and general response format, see the Overview.

Enroll Player¶

Enrolls a single player in a reward.

Endpoint: POST /v1/rewards/{rewardId}/enrollments

Path Parameters¶

Request Headers¶

Request Body¶

Example Request¶

{
  "operatorPlayerId": "player-123"
}

Example Response (FreeBets Enrollment)¶

{
  "message": "OK",
  "data": {
    "rewardType": "FreeBets",
    "id": "enr-001",
    "operatorId": 1,
    "rewardId": "rwd-001",
    "campaignOperatorReference": "OP-SUMMER-2026",
    "rewardOperatorReference": "OP-REWARD-001",
    "operatorPlayerId": "player-123",
    "products": ["plinko-8-lines"],
    "status": "New",
    "startTimeUtc": "2026-06-01T00:00:00Z",
    "endTimeUtc": "2026-06-30T23:59:59Z",
    "createdAtUtc": "2026-03-20T12:00:00Z",
    "updatedAtUtc": null,
    "cancelledAtUtc": null,
    "betValue": 0.50,
    "currencyIsoCode": "EUR",
    "totalBetCount": 10,
    "remainingBetCount": 10,
    "creditWalletType": "FreeBet",
    "stakeNotReturned": true
  },
  "responseCode": "OK"
}

Validation Rules¶

• operatorPlayerId is required and cannot be empty or whitespace.

Bulk Enroll Players¶

Enrolls multiple players in a reward in a single request.

Endpoint: POST /v1/rewards/{rewardId}/enrollments/bulk

Path Parameters¶

Request Headers¶

Request Body¶

Example Request¶

{
  "operatorPlayerIds": [
    "player-123",
    "player-456",
    "player-789"
  ]
}

Example Response¶

{
  "message": "OK",
  "data": [
    {
      "rewardType": "FreeBets",
      "id": "enr-001",
      "operatorId": 1,
      "rewardId": "rwd-001",
      "campaignOperatorReference": "OP-SUMMER-2026",
      "rewardOperatorReference": "OP-REWARD-001",
      "operatorPlayerId": "player-123",
      "products": ["plinko-8-lines"],
      "status": "New",
      "startTimeUtc": "2026-06-01T00:00:00Z",
      "endTimeUtc": "2026-06-30T23:59:59Z",
      "createdAtUtc": "2026-03-20T12:00:00Z",
      "updatedAtUtc": null,
      "cancelledAtUtc": null,
      "betValue": 0.50,
      "currencyIsoCode": "EUR",
      "totalBetCount": 10,
      "remainingBetCount": 10,
      "creditWalletType": "FreeBet",
      "stakeNotReturned": true
    },
    {
      "rewardType": "FreeBets",
      "id": "enr-002",
      "operatorId": 1,
      "rewardId": "rwd-001",
      "campaignOperatorReference": "OP-SUMMER-2026",
      "rewardOperatorReference": "OP-REWARD-001",
      "operatorPlayerId": "player-456",
      "products": ["plinko-8-lines"],
      "status": "New",
      "startTimeUtc": "2026-06-01T00:00:00Z",
      "endTimeUtc": "2026-06-30T23:59:59Z",
      "createdAtUtc": "2026-03-20T12:00:00Z",
      "updatedAtUtc": null,
      "cancelledAtUtc": null,
      "betValue": 0.50,
      "currencyIsoCode": "EUR",
      "totalBetCount": 10,
      "remainingBetCount": 10,
      "creditWalletType": "FreeBet",
      "stakeNotReturned": true
    }
  ],
  "responseCode": "OK"
}

Validation Rules¶

• operatorPlayerIds must contain less than 1,000 entries.
• Empty or whitespace-only entries are filtered out. After filtering, at least one valid entry must remain.

Get Enrollments for Reward¶

Retrieves enrollments for a specific reward with pagination support.

Endpoint: GET /v1/rewards/{rewardId}/enrollments

Path Parameters¶

Query Parameters¶

Request Headers¶

Example Request¶

GET /v1/rewards/rwd-001/enrollments?page=1&pageSize=50

Response¶

Returns an array of enrollment objects in the data field.

Validation Rules¶

• page must be greater than or equal to 1.
• pageSize must be between 1 and 500.

Cancel Enrollment¶

Cancels a specific reward enrollment.

Endpoint: POST /v1/enrollments/{enrollmentId}/cancel

Path Parameters¶

Request Headers¶

Example Response¶

{
  "message": "OK",
  "data": {},
  "responseCode": "OK"
}

Enrollment Response Fields¶

Base Fields (All Enrollment Types)¶

Additional Fields for FreeBets Enrollments¶

Typical Integration Flow¶

The following diagram illustrates a typical flow for setting up and managing reward enrollments:

sequenceDiagram
    participant Operator
    participant Gamnify as Gamnify API

    Operator->>+Gamnify: POST /v1/campaigns (Create Campaign)
    Gamnify-->>-Operator: Campaign created (status: Scheduled)

    Operator->>+Gamnify: POST /v1/campaigns/{id}/rewards (Create Reward)
    Gamnify-->>-Operator: Reward created (status: Scheduled)

    Operator->>+Gamnify: POST /v1/rewards/{id}/enrollments/bulk (Enroll Players)
    Gamnify-->>-Operator: Enrollments created (status: New)

    Note over Operator,Gamnify: Campaign start time reached

    Note over Gamnify: Enrollments transition to Active
    Note over Gamnify: Players can now use their free bets

    Operator->>+Gamnify: GET /v1/rewards/{id}/enrollments (Check Progress)
    Gamnify-->>-Operator: Enrollment statuses (Active/Claimed/Expired)