Reward Groups

Reward Group operations

Get list of Reward Groups

Role Requirements

tenant-reward-group-read or tenant-admin

Description

Gets a list of the Reward Groups.

Securitybearer
Request
header Parameters
x-account-id
required
string

The Account Id.

x-tenant-id
required
string

The Tenant Id.

x-correlation-id
string

Correlation Id for the request.

Responses
200

Returns the Rewards Groups response.

400

Bad Request - Returns the Error response object.

401

Unauthorised

403

Forbidden - If the API user does not have one of the roles listed in Role Requirements above.

get/v2/reward-groups
Request samples 
Response samples 
application/json
{
  • "rewardGroups": [
    • {
      • "rewardGroupId": "d2536a50-70ae-463a-a3c2-2c67082feeaf",
      • "name": "string",
      • "rewards": [
        • {
          • "rewardId": "string",
          • "isEnabled": true
          }
        ]
      }
    ]
}
Create a Reward Group
Role Requirements


tenant-reward-group-write or tenant-admin


Description


Creates a new Reward Group.


Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: 
name
string or null
The name of the Reward Group.


 
Array of objects or null (RewardGroupItemRequest) 
The list of Rewards and its enabled state for this Reward Group.


 
Responses 
200
Returns the Rewards Group response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


post/v2/reward-groups
Request samples 
{
  • "name": "string",
  • "rewards": [
    • {
      • "rewardId": "string",
      • "isEnabled": true
      }
    ]
}
Response samples 
application/json
{
  • "rewardGroupId": "d2536a50-70ae-463a-a3c2-2c67082feeaf",
  • "name": "string",
  • "rewards": [
    • {
      • "rewardId": "string",
      • "isEnabled": true
      }
    ]
}
Get a Reward Group
Role Requirements


tenant-reward-group-read or tenant-admin


Description


Gets a Reward Group by the rewardGroupId.


Securitybearer 
Request 
path Parameters
rewardGroupId
required
string
The Reward Group Id.


 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
Returns the Rewards Group response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


get/v2/reward-groups/{rewardGroupId}
Request samples 
Response samples 
application/json
{
  • "rewardGroupId": "d2536a50-70ae-463a-a3c2-2c67082feeaf",
  • "name": "string",
  • "rewards": [
    • {
      • "rewardId": "string",
      • "isEnabled": true
      }
    ]
}
Update a Reward Group
Role Requirements


tenant-reward-group-write or tenant-admin


Description


Updates a Reward Group by the rewardGroupId.


Securitybearer 
Request 
path Parameters
rewardGroupId
required
string
The Reward Group Id.


 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: 
name
string or null
The name of the Reward Group.


 
Array of objects or null (RewardGroupItemRequest) 
The list of Rewards and its enabled state for this Reward Group.


 
Responses 
200
Returns the rewards group response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


put/v2/reward-groups/{rewardGroupId}
Request samples 
{
  • "name": "string",
  • "rewards": [
    • {
      • "rewardId": "string",
      • "isEnabled": true
      }
    ]
}
Response samples 
application/json
{
  • "rewardGroupId": "d2536a50-70ae-463a-a3c2-2c67082feeaf",
  • "name": "string",
  • "rewards": [
    • {
      • "rewardId": "string",
      • "isEnabled": true
      }
    ]
}
Delete a Reward Group
Role Requirements


tenant-reward-group-write or tenant-admin


Description


Deletes an existing Reward Group by the rewardGroupId.


Securitybearer 
Request 
path Parameters
rewardGroupId
required
string
The Reward Group Id.


 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
204
No Content


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


delete/v2/reward-groups/{rewardGroupId}
Request samples 
Copyright 2024 Duck Creek Technologies. All Rights Reserved.