Rewards

Create a reward

Create a reward for subscribers.

POST https://api.partnero.com/v1/rewards

Request example

{
  "name": "Generic coupon reward",
  "description": "Reward description",
  "subscribers_count": 1,
  "fulfillment_type": "generic_coupon",
  "fulfillment_value": "REWARD10"
}

Request parameters

Parameters	Type	Required	Details
name	string	yes	Name of your reward. Visible in subscriber portal.
description	string	no	Description of your reward. Visible in subscriber portal.
subscribers_count	string	no	The required number of subscribers to refer in order to unlock this reward.
fulfillment_type	string	no	The type of the reward. Available values: url_link, generic_coupon, amazon_gift_card
fulfillment_value	string	no	The reward fulfillment value.

Response example

{
    "data": {
        "id": 255,
        "name": "Generic coupon reward",
        "description": "Reward description",
        "status": "active",
        "type": "default",
        "fulfillment_type": "generic_coupon",
        "fulfillment_type_name": "Coupon code",
        "fulfillment_value": "REWARD10",
        "subscriber_count": 1,
        "times_triggered": 0,
        "created_at": "2025-05-12T18:39:54.000000Z",
        "updated_at": "2025-05-12T18:39:54.000000Z"
    },
    "status": 1
}

Fetch a reward

Fetch a single reward

GET https://api.partnero.com/v1/rewards/{id}

Request example

GET https://api.partnero.com/v1/rewards/255

Request parameters

Parameters	Type	Required	Details
id	integer	yes	The ID of the reward you want to fetch.

Response

{
    "data": {
        "id": 255,
        "name": "Generic coupon reward",
        "description": "Reward description",
        "status": "active",
        "type": "default",
        "fulfillment_type": "generic_coupon",
        "fulfillment_type_name": "Coupon code",
        "fulfillment_value": "REWARD10",
        "subscriber_count": 1,
        "times_triggered": 0,
        "created_at": "2025-05-12T18:39:54.000000Z",
        "updated_at": "2025-05-12T18:39:54.000000Z"
    },
    "status": 1
}

Response Code: 200 OK
Content-Type: application/json

Get all rewards

Get all rewards

GET https://api.partnero.com/v1/rewards

Request parameters

Parameters	Type	Required	Details
limit	integer	no	The number of rewards to return.

Response

{
    "data": [
        {
            "id": 255,
            "name": "Generic coupon reward",
            "description": "Reward description",
            "status": "active",
            "type": "default",
            "fulfillment_type": "generic_coupon",
            "fulfillment_type_name": "Coupon code",
            "fulfillment_value": "REWARD10",
            "subscriber_count": 1,
            "created_at": "2025-05-12T18:39:54.000000Z",
            "updated_at": "2025-05-12T18:39:54.000000Z"
        },
        ...
    ],
    "status": 1
}

Update a reward

PUT https://api.partnero.com/v1/rewards

Request example

{
  "id": 255,
  "name": "Generic coupon reward updated"
}

Request parameters

Parameters	Type	Required	Details
id	integer	yes	The ID of the reward you want to update.
name	string	no	Name of your reward. Visible in subscriber portal.
description	string	no	Description of your reward. Visible in subscriber portal.
subscribers_count	string	no	The required number of subscribers to refer in order to unlock this reward.
fulfillment_type	string	no	The type of the reward. Available values: url_link, generic_coupon, amazon_gift_card
fulfillment_value	string	no	The reward fulfillment value.

Response example

{
    "data": {
        "id": 255,
        "name": "Generic coupon reward updated",
        "description": null,
        "status": "active",
        "type": "default",
        "fulfillment_type": "generic_coupon",
        "fulfillment_type_name": "Coupon code",
        "fulfillment_value": "REWARD10",
        "subscriber_count": 1,
        "times_triggered": 0,
        "created_at": "2025-05-12T18:39:54.000000Z",
        "updated_at": "2025-05-12T21:23:16.000000Z"
    },
    "status": 1
}

Response Code: 200 OK
Content-Type: application/json

Delete a reward

DELETE https://api.partnero.com/v1/rewards

Request example

{
  "id": 255
}

Request parameters

Parameters	Type	Required	Details
id	integer	yes	The ID of the reward you want to delete.

Response

{
    "status": 1
}

Response Code: 200 OK
Content-Type: application/json