Rewards

Get all rewards

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

Response example

{
  "data": [
    {
      "id": 195,
      "name": "10 subscribers $10 Amazon Gift Card",
      "description": "Bring 10 subscribers and get Amazon Gift card worth $10 USD.",
      "status": "active",
      "type": "default",
      "fulfillment_type": "url_link",
      "fulfillment_type_name": "URL",
      "fulfillment_value": "https://www.partnero.com",
      "subscriber_count": 1,
      "created_at": "2023-09-25T14:26:47.000000Z",
      "updated_at": "2023-12-04T12:21:02.000000Z"
    }
  ],
  "status": 1
}

Get a single reward

GET https://api.partnero.com/v1/rewards/(:id)

Response example

{
  "data": {
    "id": 195,
    "name": "10 subscribers $10 Amazon Gift Card",
    "description": "Bring 10 subscribers and get Amazon Gift card worth $10 USD.",
    "status": "active",
    "type": "default",
    "fulfillment_type": "url_link",
    "fulfillment_type_name": "URL",
    "fulfillment_value": "https://www.partnero.com",
    "subscriber_count": 1,
    "times_triggered": 2,
    "created_at": "2023-09-25T14:26:47.000000Z",
    "updated_at": "2023-12-04T12:21:02.000000Z"
  },
  "status": 1
}

Create a reward

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

Request example

{
  "name": "Reward name",
  "description": "Reward description",
  "subscribers_count": 100,
  "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
fulfillment_value	string	no	The reward fulfillment,.

Response example

{
  "data": {
    "id": 1095,
    "name": "Reward name",
    "description": "Reward description",
    "status": "active",
    "type": "default",
    "fulfillment_type": "generic_coupon",
    "fulfillment_type_name": "Coupon code",
    "fulfillment_value": "REWARD10",
    "subscriber_count": 100,
    "times_triggered": 0,
    "created_at": "2024-01-03T10:22:21.000000Z",
    "updated_at": "2024-01-03T10:22:21.000000Z"
  },
  "status": 1
}

Update a reward

PUT https://api.partnero.com/v1/rewards/(:id)

Request example

{
  "id": {REWARD_ID},
  "name": "Reward name changed"
}

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
fulfillment_value	string	no	The reward fulfillment,.

Response example

{
  "data": {
    "id": 1095,
    "name": "Reward name changed",
    "description": null,
    "status": "active",
    "type": "default",
    "fulfillment_type": "generic_coupon",
    "fulfillment_type_name": "Coupon code",
    "fulfillment_value": "REWARD10",
    "subscriber_count": 100,
    "times_triggered": 0,
    "created_at": "2024-01-03T10:22:21.000000Z",
    "updated_at": "2024-01-03T10:28:30.000000Z"
  },
  "status": 1
}

Delete a reward

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

Request example

{
  "id": {REWARD_ID}
}

Response example

{
    "status": 1
}