Skip to content

WooRewards

  1. Home
  2. Docs
  3. WooRewards
  4. Features
  5. API
  6. Methods to earn points

Methods to earn points

This documentation is for the WooRewards plugin

Use this API route to get all the methods to earn points in a points and rewards system. It requires only the general reading permission.

 

GET
/wp-json/woorewards/v1/pools/<pool_id>/methods

 

Available parameters

  • Id : Description
  • pool_id : (string) – The points and rewards system identifier.

 

Response

The JSON response is an array of earning method objects. Each object contains at least the following properties:

  • Id : Description
  • id : The method identifier to use for future references.
  • gain : The amount of points added when the method is triggered.
  • title : The public method title.
  • description : The custom method description (if any set by the administrator).

 

Error cases

A 404 error is raised if the points and rewards system identifier cannot be found.

Scroll To Top