GENIUS REFERRALS API DOCUMENTATION

body format: request format: api key:

Genius Referrals Web API

The Genius Referrals API allows you to integrate with our platform using any programming language such as PHP, Javascript, Java, C#, Python, Ruby, etc..

Here you can review and test all our endpoints. We have developed a set of resources that you can use in your integration process to provide a high-quality referral marketing solution for your apps. Since the API is based on REST principles, it's easy to write and test applications.

You can use your browser to access URLs, and you can use pretty much any HTTP client in any programming language to interact with the API. Check out our SDKs and sample Website.

Using SANDBOX

The Genius Referrals Sandbox tool helps you consume our API Resources to develop and test your Referral Program quickly.

Getting started with Sandbox:

Go to the credentials page and copy your API token.
Enter the API token on the field below.
Select the resource that you want to test. e.g., under Authentications, click on GET /authentications.
Click on the Sandbox tab on the top left corner to open the detail section.
On the left-hand corner, click the 'Try it out' button.

Show/hide List Operations Expand Operations

Accounts

/accounts

GET /accounts

Get accounts

Documentation
Sandbox

Documentation

Get the list of accounts.

Response Format

{
    "code": 200,
    "data": {
        "limit": 1,
        "page": 1,
        "results": [
            {
                "_currencies": "USD, GBP",
                "created": "2014-01-27T03:48:09+0000",
                "is_active": true,
                "name": "Example.com",
                "slug": "example-com",
                "url": "http://www.example.com"
            }
        ],
        "total": 2
    }
}

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: name. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: name, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
url	string	*
is_active	boolean	*
_domains	string	*
is_live	boolean	*
created	DateTime	*
updated	DateTime	*
slug	string	*
_currencies	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}

GET /accounts/{account_slug}

Get an account

Documentation
Sandbox

Documentation

Get an account by a given slug.

Response Format

{
   "code": 200,
   "data": {
       "_currencies": "USD, GBP",
       "created": "2014-01-27T03:48:09+0000",
       "is_active": true,
       "name": "Example.com",
       "slug": "example-com",
       "url": "http://www.example.com"
   }

}

Requirements

Name	Requirement	Type	Description
account_slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
url	string	*
is_active	boolean	*
_domains	string	*
is_live	boolean	*
created	DateTime	*
updated	DateTime	*
slug	string	*
_currencies	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Advocates

/accounts/{account_slug}/advocates

DELETE /accounts/{account_slug}/advocates

Delete all advocates

Documentation
Sandbox

Documentation

Delete all advocates

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/advocates

Get advocates

Documentation
Sandbox

Documentation

Get the list of advocates in a specific account.

Response Format

  {
      "code": 200,
      "data": {
          "page": 2,
          "limit": 1,
          "total": 2,
          "results": [
              {
                  "email": "janedoe_at_geniusreferrals.com",
                  "lastname": "Doe",
                  "name": "Jane",
                  "token": "8f362f2ff2250ff20272598b7459129ff3826968",
                  "short_token": "ubEa0",
                  "code": "janedoe15off",
                  "payout_threshold": 1,
                  "claimed_balance": 0,
                  "unclaimed_balance": 0,
                  "total_referrals": 0,
                  "total_bonuses": 0,
                  "created": "2018-11-09T05:04:30+0000",
                  "metadata": "[{\"label\":\"Phone Number\",\"value\":\"14928483822\"}]",
                  "can_refer": false,
                  "firstname": "Jane",
                  "status": "active",
                  "status_date": "2019-05-15T03:51:42+00:00",
                  "setting": {
                      "statusLogs": "[{\"status\":\"active\",\"date\":\"2019-05-15 03:51:42\"}]"
                  },
                  "is_email_confirmed": true,
                  "fraudulent" : false,
                  "_campaign": {
                      "name": "New campaign Get 15% for 90 days",
                      "description": "New campaign Get 15% for 90 days",
                      "start_date": "2019-05-08T02:03:50+0000",
                      "is_active": true
                  },
                  "widgets_package_slug":"get-6-on-first-order-23",
                  "_advocate_referrer": {
                      "email": "johndoe_at_geniusreferrals.com",
                      "lastname": "Doe",
                      "name": "John",
                      "token": "0770e11007636ec58425f486214213f0a25f2c00",
                      "short_token": "VMZFi",
                      "code": "johndoe15off",
                      "payout_threshold": 1,
                      "claimed_balance": 0,
                      "unclaimed_balance": 5,
                      "total_referrals": 1,
                      "total_bonuses": 1,
                      "created": "2018-11-09T05:04:30+0000",
                      "metadata": "[{\"label\":\"Phone Number\",\"value\":\"14332828929\"}]",
                      "can_refer": true,
                      "firstname": "John",
                      "_currency": {
                          "code": "USD",
                          "unicode": "36",
                          "currency": "United States Dollar",
                          "suffix": "¢",
                          "updated": "2018-11-12T17:58:18+0000"
                      },
                  "_bonuses_redemption_method": {
                      "name": "Auto into credit",
                      "description": "Automatically exchange the bonuses as credit",
                      "slug": "auto-into-credit"
                      }
                  },
                  "_currency": {
                      "code": "USD",
                      "unicode": "36",
                      "currency": "United States Dollar",
                      "suffix": "¢",
                      "updated": "2018-11-12T17:58:18+0000"
                  },
                  "_bonuses_redemption_method": {
                      "name": "Auto into credit",
                      "description": "Automatically exchange the bonuses as credit",
                      "slug": "auto-into-credit"
                  }
              }
          ]
      }
  }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: fullname, name, lastname, email, advocate_token, advocate_code, bonus_exchange_method_slug, campaign_slug, can_refer, is_referral, from, to, created, status, status_date_from, status_date_to, is_email_confirmed, campaign_contract_slug, advocate_referrer_token, fraudulent. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: name, lastname, email, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
email	string	*
lastname	string	*
name	string	*
token	string	*
short_token	string	*
code	string	*
payout_threshold	float	*
claimed_balance	float	*
unclaimed_balance	float	*
total_referrals	integer	*
total_bonuses	integer	*
created	DateTime	*
updated	DateTime	*
total_clicks	integer	*
total_shares	integer	*
avatar_url	string	*
metadata	string	*
can_refer	boolean	*
status	string	*
status_date	DateTime	*
setting	array	*
is_email_confirmed	boolean	*
fraudulent	boolean	*
_advocate_referrer	object (Advocate)	*
_advocate_referrer[email]	string	*
_advocate_referrer[lastname]	string	*
_advocate_referrer[name]	string	*
_advocate_referrer[token]	string	*
_advocate_referrer[short_token]	string	*
_advocate_referrer[code]	string	*
_advocate_referrer[payout_threshold]	float	*
_advocate_referrer[claimed_balance]	float	*
_advocate_referrer[unclaimed_balance]	float	*
_advocate_referrer[total_referrals]	integer	*
_advocate_referrer[total_bonuses]	integer	*
_advocate_referrer[created]	DateTime	*
_advocate_referrer[updated]	DateTime	*
_advocate_referrer[total_clicks]	integer	*
_advocate_referrer[total_shares]	integer	*
_advocate_referrer[avatar_url]	string	*
_advocate_referrer[metadata]	string	*
_advocate_referrer[can_refer]	boolean	*
_advocate_referrer[status]	string	*
_advocate_referrer[status_date]	DateTime	*
_advocate_referrer[setting]	array	*
_advocate_referrer[is_email_confirmed]	boolean	*
_advocate_referrer[fraudulent]	boolean	*
_advocate_referrer[_advocate_referrer]	object (Advocate)	*
_advocate_referrer[_currency]	object (Currency)	*
_advocate_referrer[_currency][code]	string	*
_advocate_referrer[_currency][unicode]	string	*
_advocate_referrer[_currency][currency]	string	*
_advocate_referrer[_currency][suffix]	string	*
_advocate_referrer[_currency][updated]	DateTime	*
_advocate_referrer[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate_referrer[_bonuses_redemption_method][name]	string	*
_advocate_referrer[_bonuses_redemption_method][description]	string	*
_advocate_referrer[_bonuses_redemption_method][slug]	string	*
_advocate_referrer[_campaign_contract]	object (Campaign)	*
_advocate_referrer[_campaign_contract][name]	string	*
_advocate_referrer[_campaign_contract][description]	string	*
_advocate_referrer[_campaign_contract][start_date]	DateTime	*
_advocate_referrer[_campaign_contract][end_date]	DateTime	*
_advocate_referrer[_campaign_contract][is_active]	boolean	*
_advocate_referrer[_campaign_contract][schemaless_config]	string	*
_advocate_referrer[_campaign_contract][created]	DateTime	*
_advocate_referrer[_campaign_contract][updated]	DateTime	*
_advocate_referrer[_campaign_contract][slug]	string	*
_advocate_referrer[_campaign_contract][total_advocates]	integer	*
_advocate_referrer[_campaign_contract][startDate]	DateTime	*
_advocate_referrer[_campaign_contract][endDate]	DateTime	*
_advocate_referrer[_campaign_contract][isActive]	bool	*
_advocate_referrer[_campaign_contract][schemalessConfig]		*
_advocate_referrer[_campaign]	object (Campaign)	*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_bonuses_redemption_method	object (BonusExchangeMethod)	*
_bonuses_redemption_method[name]	string	*
_bonuses_redemption_method[description]	string	*
_bonuses_redemption_method[slug]	string	*
_campaign_contract	object (Campaign)	*
_campaign_contract[name]	string	*
_campaign_contract[description]	string	*
_campaign_contract[start_date]	DateTime	*
_campaign_contract[end_date]	DateTime	*
_campaign_contract[is_active]	boolean	*
_campaign_contract[schemaless_config]	string	*
_campaign_contract[created]	DateTime	*
_campaign_contract[updated]	DateTime	*
_campaign_contract[slug]	string	*
_campaign_contract[total_advocates]	integer	*
_campaign_contract[startDate]	DateTime	*
_campaign_contract[endDate]	DateTime	*
_campaign_contract[isActive]	bool	*
_campaign_contract[schemalessConfig]		*
_campaign	object (Campaign)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/advocates

Create an advocate

Documentation
Sandbox

Documentation

Create a new advocate or referral in our platform. Usually referrals are turned into advocates when they start referring your services. Note that a referral can be turn into an advocate by setting property can_refer to true.

To create a new advocate set the property can_refer to true.

To create a new referral, you need an advocate and a referral. First create a new advocate with property can_refer=true, then create the another advocate (referral) with property can_refer=false, and finally create a new referral (POST /accounts/{account_slug}/advocates/{advocate_token}/referrals) to link the advocate and the referral.

Request Format

Not all parameters in the content of the request are mandatory. Parameters avatar_url, metadata, currency_code, can_refer, status, fraudulent, fraud_detected_by and fraud_rule are optional.

{
"advocate":{
"firstname":"Jonh",
"lastname":"Smith",
"email": "jonh_at_email.com",
"payout_threshold":10,
"avatar_url":"http://www.example.com/myavatar.png",
"metadata":"extra metadata",
"can_refer": 1,
"currency_code": "USD",
"status": "active",
"fraudulent": 0,
"fraud_detected_by" : "client",
"fraud_rule": "same_email"
}
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}

DELETE /accounts/{account_slug}/advocates/{advocate_token}

Delete an advocate

Documentation
Sandbox

Documentation

Delete an advocate

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/advocates/{advocate_token}

Get an advocate

Documentation
Sandbox

Documentation

Get an advocate by a given token.

Response Format

 {
     "code": 200,
     "data": {
         "email": "janedoe@geniusreferrals.com",
         "lastname": "Doe",
         "name": "Jane",
         "token": "8f362f2ff2250ff20272598b7459129ff3826968",
         "short_token": "ubEa0",
         "code": "janedoe15off",
         "payout_threshold": 1,
         "claimed_balance": 0,
         "unclaimed_balance": 0,
         "total_referrals": 0,
         "total_bonuses": 0,
         "created": "2018-11-09T05:04:30+0000",
         "metadata": "[{\"label\":\"Phone Number\",\"value\":\"14928483822\"}]",
         "can_refer": false,
         "firstname": "Jane",
         "status": "active",
         "status_date": "2019-05-15T03:51:42+00:00",
         "setting": {
             "statusLogs": "[{\"status\":\"active\",\"date\":\"2019-05-15 03:51:42\"}]"
         },
         "is_email_confirmed": true,
         "fraudulent" : false,
         "_campaign": {
             "name": "New campaign Get 15% for 90 days",
             "description": "New campaign Get 15% for 90 days",
             "start_date": "2019-05-08T02:03:50+0000",
             "is_active": true
         },
         "widgets_package_slug":"get-6-on-first-order-23",
         "_advocate_referrer": {
             "email": "johndoe@geniusreferrals.com",
             "lastname": "Doe",
             "name": "John",
             "token": "0770e11007636ec58425f486214213f0a25f2c00",
             "short_token": "VMZFi",
             "code": "johndoe15off",
             "payout_threshold": 1,
             "claimed_balance": 0,
             "unclaimed_balance": 5,
             "total_referrals": 1,
             "total_bonuses": 1,
             "created": "2018-11-09T05:04:30+0000",
             "metadata": "[{\"label\":\"Phone Number\",\"value\":\"14332828929\"}]",
             "can_refer": true,
             "firstname": "John",
             "_currency": {
                 "code": "USD",
                 "unicode": "36",
                 "currency": "United States Dollar",
                 "suffix": "¢",
                 "updated": "2018-11-12T17:58:18+0000"
             },
             "_bonuses_redemption_method": {
                 "name": "Auto into credit",
                 "description": "Automatically exchange the bonuses as credit",
                 "slug": "auto-into-credit"
             }
         },
         "_currency": {
         "code": "USD",
         "unicode": "36",
         "currency": "United States Dollar",
             "suffix": "¢",
             "updated": "2018-11-12T17:58:18+0000"
         },
         "_bonuses_redemption_method": {
              "name": "Auto into credit",
              "description": "Automatically exchange the bonuses as credit",
              "slug": "auto-into-credit"
         }
      }
  }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		string	the advocate token

Return

Parameter	Type	Versions
200 - Returned when successful
email	string	*
lastname	string	*
name	string	*
token	string	*
short_token	string	*
code	string	*
payout_threshold	float	*
claimed_balance	float	*
unclaimed_balance	float	*
total_referrals	integer	*
total_bonuses	integer	*
created	DateTime	*
updated	DateTime	*
total_clicks	integer	*
total_shares	integer	*
avatar_url	string	*
metadata	string	*
can_refer	boolean	*
status	string	*
status_date	DateTime	*
setting	array	*
is_email_confirmed	boolean	*
fraudulent	boolean	*
_advocate_referrer	object (Advocate)	*
_advocate_referrer[email]	string	*
_advocate_referrer[lastname]	string	*
_advocate_referrer[name]	string	*
_advocate_referrer[token]	string	*
_advocate_referrer[short_token]	string	*
_advocate_referrer[code]	string	*
_advocate_referrer[payout_threshold]	float	*
_advocate_referrer[claimed_balance]	float	*
_advocate_referrer[unclaimed_balance]	float	*
_advocate_referrer[total_referrals]	integer	*
_advocate_referrer[total_bonuses]	integer	*
_advocate_referrer[created]	DateTime	*
_advocate_referrer[updated]	DateTime	*
_advocate_referrer[total_clicks]	integer	*
_advocate_referrer[total_shares]	integer	*
_advocate_referrer[avatar_url]	string	*
_advocate_referrer[metadata]	string	*
_advocate_referrer[can_refer]	boolean	*
_advocate_referrer[status]	string	*
_advocate_referrer[status_date]	DateTime	*
_advocate_referrer[setting]	array	*
_advocate_referrer[is_email_confirmed]	boolean	*
_advocate_referrer[fraudulent]	boolean	*
_advocate_referrer[_advocate_referrer]	object (Advocate)	*
_advocate_referrer[_currency]	object (Currency)	*
_advocate_referrer[_currency][code]	string	*
_advocate_referrer[_currency][unicode]	string	*
_advocate_referrer[_currency][currency]	string	*
_advocate_referrer[_currency][suffix]	string	*
_advocate_referrer[_currency][updated]	DateTime	*
_advocate_referrer[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate_referrer[_bonuses_redemption_method][name]	string	*
_advocate_referrer[_bonuses_redemption_method][description]	string	*
_advocate_referrer[_bonuses_redemption_method][slug]	string	*
_advocate_referrer[_campaign_contract]	object (Campaign)	*
_advocate_referrer[_campaign_contract][name]	string	*
_advocate_referrer[_campaign_contract][description]	string	*
_advocate_referrer[_campaign_contract][start_date]	DateTime	*
_advocate_referrer[_campaign_contract][end_date]	DateTime	*
_advocate_referrer[_campaign_contract][is_active]	boolean	*
_advocate_referrer[_campaign_contract][schemaless_config]	string	*
_advocate_referrer[_campaign_contract][created]	DateTime	*
_advocate_referrer[_campaign_contract][updated]	DateTime	*
_advocate_referrer[_campaign_contract][slug]	string	*
_advocate_referrer[_campaign_contract][total_advocates]	integer	*
_advocate_referrer[_campaign_contract][startDate]	DateTime	*
_advocate_referrer[_campaign_contract][endDate]	DateTime	*
_advocate_referrer[_campaign_contract][isActive]	bool	*
_advocate_referrer[_campaign_contract][schemalessConfig]		*
_advocate_referrer[_campaign]	object (Campaign)	*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_bonuses_redemption_method	object (BonusExchangeMethod)	*
_bonuses_redemption_method[name]	string	*
_bonuses_redemption_method[description]	string	*
_bonuses_redemption_method[slug]	string	*
_campaign_contract	object (Campaign)	*
_campaign_contract[name]	string	*
_campaign_contract[description]	string	*
_campaign_contract[start_date]	DateTime	*
_campaign_contract[end_date]	DateTime	*
_campaign_contract[is_active]	boolean	*
_campaign_contract[schemaless_config]	string	*
_campaign_contract[created]	DateTime	*
_campaign_contract[updated]	DateTime	*
_campaign_contract[slug]	string	*
_campaign_contract[total_advocates]	integer	*
_campaign_contract[startDate]	DateTime	*
_campaign_contract[endDate]	DateTime	*
_campaign_contract[isActive]	bool	*
_campaign_contract[schemalessConfig]		*
_campaign	object (Campaign)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /accounts/{account_slug}/advocates/{advocate_token}

Update an advocate

Documentation
Sandbox

Documentation

Update partial elements of an advocate.

Use this method when you do not need to update all the elements at the same time.

Allowed parameters to be updated are: name, lastname, email, token, code, payout_threshold, claimed_balance, unclaimed_balance, currency_code, avatar_url, metadata and can_refer, status, reason, is_email_confirmed, campaign_slug, fraudulent, fraud_detected_by and fraud_rule

Request Format

{
"firstname":"Jonh",
"lastname":"Smith",
"email": "jonh_at_example.com",
"payout_threshold":10,
"claimed_balance":10,
"unclaimed_balance":10,
"currency_code": "USD",
"avatar_url":"http://www.geniusreferrals.com/bundles/frontend/images/geniusreferrals-logo.png",
"metadata":"extra metadata",
"can_refer": 1,
"code" : "get15off",
"status": "active",
"reason": "The reason",
"is_email_confirmed": 1,
"campaign_slug": "get-5-on-first-order",
"widgets_package_slug":"get-6-on-first-order-23",
"fraudulent": 1,
"fraud_detected_by": "client",
"fraud_rule": "fraud_rule"
}
-- OR --

{"firstname":"Jonh"}

-- OR send a query string like this --

payout_threshold=10&claimed_balance=10&unclaimed_balance=10&currency_code=EUR

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /accounts/{account_slug}/advocates/{advocate_token}

Update an advocate

Documentation
Sandbox

Documentation

Update an advocate.

Request Format

Not all parameters in the content of the request are mandatory. Parameters avatar_url, metadata, currency_code, can_refer, status, fraudulent, fraud_detected_by and fraud_rule are optional.

{
"advocate":{
"firstname":"Jonh",
"lastname":"Smith",
"email": "jonh_at_email.com",
"payout_threshold":10,
"avatar_url":"http://www.example.com/myavatar.png",
"metadata":"extra metadata",
"can_refer": 1,
"currency_code": "USD",
"status": "active",
"fraudulent": 0,
"fraud_detected_by" : "client",
"fraud_rule": "same_email"
}
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}/payment-methods

GET /accounts/{account_slug}/advocates/{advocate_token}/payment-methods

Get advocate's payment methods

Documentation
Sandbox

Documentation

Get the advocate's payment methods.

Response Format

{
    "code": 200,
    "data": {
        "limit": 10,
        "page": 1,
        "results": [
            {
                "created": "2014-01-16T20:59:59+0000",
                "description": "Paypal account",
                "id": 1,
                "is_active": true,
                "username": "advocate_at_email.com"
            }
        ],
        "total": 1
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		integer	the advocate token

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: username, is_active, payment_method_slug. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: username, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
username	string	*
description	string	*
isActive	bool	*
id	integer	*
is_active	boolean	*
schemaless_config	array	*
created	DateTime	*
updated	DateTime	*
_payment_method	object (PaymentMethod)	*
_payment_method[name]	string	*
_payment_method[slug]	string	*
_payment_method[description]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/advocates/{advocate_token}/payment-methods

Create a payment method

Documentation
Sandbox

Documentation

Create a new payment method.

Request Format

All parameters in the content of the request are mandatory.

{
    "advocate_payment_method": {
        "payment_method_slug":"paypal",
        "description":"Paypal Account",
        "is_active": true,
        "schemaless_config": {
            "username": "advocate_at_email.com"
        }
    }
}
-- OR --
{
    "advocate_payment_method": {
        "payment_method_slug":"bank-transfer",
        "description":"Bank Transfer Account",
        "is_active": true,
        "schemaless_config": {
            "full_name": "John Doe",
            "account_number" :"GB90BARC20038423228532",
            "extra_fields": {
                "identification_number": "100100",
                "swift_code" : "PMFAUS66",
                "phone_number" : "14928483822"
            }
        }
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		integer	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}/payment-methods/{advocate_payment_method_id}

GET /accounts/{account_slug}/advocates/{advocate_token}/payment-methods/{advocate_payment_method_id}

Get an advocate's payment method

Documentation
Sandbox

Documentation

Get an advocate's payment method

Response Format

 {
    "code": 200,
    "data": {
        "created": "2014-01-16T20:59:59+0000",
        "description": "Paypal account",
        "id": 1,
        "is_active": true,
        "username": "advocate_at_email.com"
    }
}

Requirements

Name	Requirement	Type	Description
advocate_payment_method_id	\d+	string	the payment method id
account_slug		string	the client account slug
advocate_token		string	the advocate token

Return

Parameter	Type	Versions
200 - Returned when successful
username	string	*
description	string	*
isActive	bool	*
id	integer	*
is_active	boolean	*
schemaless_config	array	*
created	DateTime	*
updated	DateTime	*
_payment_method	object (PaymentMethod)	*
_payment_method[name]	string	*
_payment_method[slug]	string	*
_payment_method[description]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /accounts/{account_slug}/advocates/{advocate_token}/payment-methods/{advocate_payment_method_id}

Update a payment method

Documentation
Sandbox

Documentation

Update a payment method.

Request Format

All parameters in the content of the request are mandatory.

{
    "advocate_payment_method": {
        "payment_method_slug":"paypal",
        "description":"Paypal Account",
        "is_active": true,
        "schemaless_config": {
            "username": "advocate_at_email.com"
        }
    }
}
-- OR --
{
    "advocate_payment_method": {
        "payment_method_slug":"bank-transfer",
        "description":"Bank Transfer Account",
        "is_active": true,
        "schemaless_config": {
            "full_name": "John Doe",
            "account_number" :"GB90BARC20038423228532",
            "extra_fields": {
                "identification_number": "100100",
                "swift_code" : "PMFAUS66",
                "phone_number" : "14928483822"
            }
        }
    }
}

Requirements

Name	Requirement	Type	Description
advocate_payment_method_id	\d+	string	the payment method id
account_slug		string	the client account slug
advocate_token		integer	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}/share-links

GET /accounts/{account_slug}/advocates/{advocate_token}/share-links

Get list of share links

Documentation
Sandbox

Documentation

Get list of share links that your advocate will share socially with their friends. When a friend clicks on one of this links we will be able to track new shares, clicks, and referrals.

This list of share links is unique to your advocate.

Response Format

{
"code": 200,
"data": {
"get-10-of-for-90-days": {
"my-first-package": {
"direct-email": "https://gr3f.co/c/e2323/62",
"facebook-share": "https://gr3f.co/s/e2323/57",
"google-1": "https://gr3f.co/s/e2323/59",
"linkedin-post": "https://gr3f.co/s/e2323/60",
"personal": "https://gr3f.co/c/e2323/63",
"pin-it": "https://gr3f.co/s/e2323/61",
"twitter-post": "https://gr3f.co/s/e2323/58"
}
}
}
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/bonuses-redemption-methods

GET /utilities/bonuses-redemption-methods

Get bonuses redemption methods

Documentation
Sandbox

Documentation

Get bonuses redemption methods.

Response Format

{
"code": 200,
"data": [
{
"description": "Automatically exchange the bonuses as credit",
"name": "Auto into credit",
"slug": "auto-into-credit"
},
{
"description": "Automatically exchange the bonuses as cash",
"name": "Auto into cash",
"slug": "auto-into-cash"
},
{
"description": "Make a decision on how echange the bonuses",
"name": "Make a decision",
"slug": "make-a-decision"
}
]
}

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/bonuses-redemption-methods/{bonuses_redemption_method_slug}

GET /utilities/bonuses-redemption-methods/{bonuses_redemption_method_slug}

Get bonuses redemption method

Documentation
Sandbox

Documentation

Get bonuses redemption method.

Response Format

{
"code": 200,
"data": {
"description": "Automatically exchange the bonuses as credit",
"name": "Auto into credit",
"slug": "auto-into-credit"
}
}

Requirements

Name	Requirement	Type	Description
bonuses_redemption_method_slug		string	the bonuses redemption method slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/currencies

GET /utilities/currencies

Get currencies

Documentation
Sandbox

Documentation

Get currencies.

Response Format

{
"code": 200,
"data": [
{
"code": "GBP",
"currency": "British Pounds ",
"suffix": "p",
"unicode": "163",
"updated": "2014-02-15T20:41:42+0000"
},
{
"code": "EUR",
"currency": "Euro",
"suffix": "¢",
"unicode": "8364",
"updated": "2014-02-15T20:41:43+0000"
},
{
"code": "USD",
"currency": "United States Dollar",
"suffix": "¢",
"unicode": "32",
"updated": "2014-02-15T20:41:43+0000"
}
]
}

Return

Parameter	Type	Versions
200 - Returned when successful
code	string	*
unicode	string	*
currency	string	*
suffix	string	*
updated	DateTime	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/currencies/{code}

GET /utilities/currencies/{code}

Get a currency

Documentation
Sandbox

Documentation

Get a currency.

Response Format

{
"code": 200,
"data": {
"code": "USD",
"currency": "United States Dollar",
"suffix": "¢",
"unicode": "32",
"updated": "2014-02-15T20:41:43+0000"
}
}

Requirements

Name	Requirement	Type	Description
code		string	the currency code

Return

Parameter	Type	Versions
200 - Returned when successful
code	string	*
unicode	string	*
currency	string	*
suffix	string	*
updated	DateTime	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/payment-methods

GET /utilities/payment-methods

Get payment methods

Documentation
Sandbox

Documentation

Get payment methods.

Response Format

{
    "code": 200,
    "data": [
        {
            "name": "PayPal",
            "slug": "paypal",
            "description": "PayPal Payment Method",
        },
        {
            "name": "Bank Transfer",
            "slug": "bank-transfer",
            "description": "Bank Transfer Payment Method",
        }
    ]
}

Status Codes

Status Code	Description
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Authentications
- /test-authentication
  - - GET /test-authentication
      
      Test authentication
      Documentation
      
      Sandbox
      
      Documentation
      
      Allow clients to test authentication on Genius Referrals platform.
      
      Expected Response
      
      { "code": 200, "message": "Hello jonh_at_mail.com!, You've successfully authenticated on Genius Referrals platform." }
      
      Input
      
      Headers
      = -
      
      Content
      = Replaces header if set
      
      Request URL
      
      Request body
      
      Response Headers [Expand] [Profiler]
      
      Response Body [Raw]
      
      Curl Command Line

Show/hide List Operations Expand Operations

Bonuses

/accounts/{account_slug}/bonuses

GET /accounts/{account_slug}/bonuses

Get bonuses

Documentation
Sandbox

Documentation

Get the list of bonuses for a given account.

Response Format

{
    "code": 200,
    "data": {
        "limit": 10,
        "page": 1,
        "results": [
            {
                "_advocate": {
                    "_bonuses_redemption_method": {
                        "description": "Automatically redeem the bonuses as credit",
                        "name": "Auto into credit",
                        "slug": "auto-into-credit"
                    },
                    "_currency": {
                        "code": "USD",
                        "currency": "United States Dollar",
                        "suffix": "¢",
                        "unicode": "32"
                    },
                    "claimed_balance": 0,
                    "created": "2014-01-16T20:59:59+0000",
                    "email": "advocate_at_mail.com",
                    "lastname": "Hernandez",
                    "firstname": "Advocate",
                    "payout_threshold": 10,
                    "token": "0c46a4da6381b7d3fa7cf9ca32b95585a24b8697",
                    "unclaimed_balance": 0
                },
                "_currency": {
                    "code": "USD",
                    "currency": "United States Dollar",
                    "suffix": "¢",
                    "unicode": "32"
                },
                bonus_request_trace: {
                    "id": 14,
                    "trace": "trace data",
                    "message": "Message",
                    "reference": "14587962",
                    "created": "2014-02-27T01:36:42+0000",
                    "updated": "2014-02-27T01:36:42+0000",
                    "advocate_referrer_token": "43277f772ba9a01e485c4641132be8ed6521a09b",
                    "advocate_token": "14985d98c28bd32bd5142e0df11b003398fddc47",
                    "bonuses" : [],
                    "campaign_slug": "get-1-on-first-order",
                    "bonus_amount": 1,
                    "result": "success"
                },
                "amount": 10,
                "referred_advocate_email":"erica@gmail.com",
                "referred_advocate_full_name":"Erica Chagas",
                "created": "2014-01-16T20:59:59+0000",
                "id": 1,
                "referred_advocate_token": "0469ec86727ddd6c2be75d171200a8f1329a2dbc",
                "payment_amount": 12.3,
                "reference":"XRE3456",
                "status": "pending",
                "status_date": "2019-05-15T03:51:42+00:00",
                "setting": {
                    "statusLogs": "[{\"status\":\"pending\",\"date\":\"2019-05-15 03:51:42\"}]"
                }
            }
        ],
        "total": 1
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: name, lastname, fullname, email, referral_name, referral_lastname, referral_fullname, referral_email, campaign_slug, reference, created, from, to, status, status_date_from, status_date_to, advocate_token, referred_advocate_token, is_redeemed, payment_amount_from, payment_amount_to, amount, amount_from, amount_to, tag_slug, tag_name. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
amount	float	*
created	DateTime	*
updated	DateTime	*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_advocate	object (Advocate)	*
_advocate[email]	string	*
_advocate[lastname]	string	*
_advocate[name]	string	*
_advocate[token]	string	*
_advocate[short_token]	string	*
_advocate[code]	string	*
_advocate[payout_threshold]	float	*
_advocate[claimed_balance]	float	*
_advocate[unclaimed_balance]	float	*
_advocate[total_referrals]	integer	*
_advocate[total_bonuses]	integer	*
_advocate[created]	DateTime	*
_advocate[updated]	DateTime	*
_advocate[total_clicks]	integer	*
_advocate[total_shares]	integer	*
_advocate[avatar_url]	string	*
_advocate[metadata]	string	*
_advocate[can_refer]	boolean	*
_advocate[status]	string	*
_advocate[status_date]	DateTime	*
_advocate[setting]	array	*
_advocate[is_email_confirmed]	boolean	*
_advocate[fraudulent]	boolean	*
_advocate[_advocate_referrer]	object (Advocate)	*
_advocate[_currency]	object (Currency)	*
_advocate[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate[_bonuses_redemption_method][name]	string	*
_advocate[_bonuses_redemption_method][description]	string	*
_advocate[_bonuses_redemption_method][slug]	string	*
_advocate[_campaign_contract]	object (Campaign)	*
_advocate[_campaign_contract][name]	string	*
_advocate[_campaign_contract][description]	string	*
_advocate[_campaign_contract][start_date]	DateTime	*
_advocate[_campaign_contract][end_date]	DateTime	*
_advocate[_campaign_contract][is_active]	boolean	*
_advocate[_campaign_contract][schemaless_config]	string	*
_advocate[_campaign_contract][created]	DateTime	*
_advocate[_campaign_contract][updated]	DateTime	*
_advocate[_campaign_contract][slug]	string	*
_advocate[_campaign_contract][total_advocates]	integer	*
_advocate[_campaign_contract][startDate]	DateTime	*
_advocate[_campaign_contract][endDate]	DateTime	*
_advocate[_campaign_contract][isActive]	bool	*
_advocate[_campaign_contract][schemalessConfig]		*
_advocate[_campaign]	object (Campaign)	*
_referred_advocate	object (Advocate)	*
bonus_request_trace	object (BonusRequestTrace)	*
bonus_request_trace[id]	integer	*
bonus_request_trace[trace]	string	*
bonus_request_trace[message]	string	*
bonus_request_trace[reference]	string	*
bonus_request_trace[created]	DateTime	*
bonus_request_trace[updated]	DateTime	*
bonus_request_trace[advocate_referrer_token]	string	*
bonus_request_trace[advocate_token]	string	*
bonus_request_trace[campaign_slug]	string	*
bonus_request_trace[bonus_amount]	float	*
bonus_request_trace[result]	string	*
bonus_request_trace[bonuses][]	array of objects (Bonus)	*
bonus_request_trace[bonuses][][id]	integer	*
bonus_request_trace[bonuses][][amount]	float	*
bonus_request_trace[bonuses][][created]	DateTime	*
bonus_request_trace[bonuses][][updated]	DateTime	*
bonus_request_trace[bonuses][][_currency]	object (Currency)	*
bonus_request_trace[bonuses][][_advocate]	object (Advocate)	*
bonus_request_trace[bonuses][][_referred_advocate]	object (Advocate)	*
bonus_request_trace[bonuses][][bonus_request_trace]	object (BonusRequestTrace)	*
bonus_request_trace[bonuses][][referred_advocate_token]	string	*
bonus_request_trace[bonuses][][referred_advocate_full_name]	string	*
bonus_request_trace[bonuses][][referred_advocate_email]	string	*
bonus_request_trace[bonuses][][referred_advocate_currency_code]	string	*
bonus_request_trace[bonuses][][referred_advocate_can_refer]	boolean	*
bonus_request_trace[bonuses][][redemption_request_id]	integer	*
bonus_request_trace[bonuses][][_bonus_type]	object (BonusType)	*
bonus_request_trace[bonuses][][_bonus_type][name]	string	*
bonus_request_trace[bonuses][][_bonus_type][description]	string	*
bonus_request_trace[bonuses][][_bonus_type][slug]	string	*
bonus_request_trace[bonuses][][reference]	string	*
bonus_request_trace[bonuses][][payment_amount]	float	*
bonus_request_trace[bonuses][][status]	string	*
bonus_request_trace[bonuses][][status_date]	DateTime	*
bonus_request_trace[bonuses][][setting]	array	*
bonus_request_trace[bonuses][][_tags][]	array of objects (Tag)	*
bonus_request_trace[bonuses][][_tags][][name]	string	*
bonus_request_trace[bonuses][][_tags][][slug]	string	*
bonus_request_trace[bonuses][][_tags][][description]	string	*
bonus_request_trace[bonuses][][_tags][][color]	string	*
bonus_request_trace[bonuses][][_tags][][created]	DateTime	*
bonus_request_trace[bonuses][][_tags][][updated]	DateTime	*
bonus_request_trace[bonuses][][_campaign]	object (Campaign)	*
bonus_request_trace[bonuses][][_campaign][name]	string	*
bonus_request_trace[bonuses][][_campaign][description]	string	*
bonus_request_trace[bonuses][][_campaign][start_date]	DateTime	*
bonus_request_trace[bonuses][][_campaign][end_date]	DateTime	*
bonus_request_trace[bonuses][][_campaign][is_active]	boolean	*
bonus_request_trace[bonuses][][_campaign][schemaless_config]	string	*
bonus_request_trace[bonuses][][_campaign][created]	DateTime	*
bonus_request_trace[bonuses][][_campaign][updated]	DateTime	*
bonus_request_trace[bonuses][][_campaign][slug]	string	*
bonus_request_trace[bonuses][][_campaign][total_advocates]	integer	*
bonus_request_trace[bonuses][][_campaign][startDate]	DateTime	*
bonus_request_trace[bonuses][][_campaign][endDate]	DateTime	*
bonus_request_trace[bonuses][][_campaign][isActive]	bool	*
bonus_request_trace[bonuses][][_campaign][schemalessConfig]		*
referred_advocate_token	string	*
referred_advocate_full_name	string	*
referred_advocate_email	string	*
referred_advocate_currency_code	string	*
referred_advocate_can_refer	boolean	*
redemption_request_id	integer	*
_bonus_type	object (BonusType)	*
_bonus_type[name]	string	*
_bonus_type[description]	string	*
_bonus_type[slug]	string	*
reference	string	*
payment_amount	float	*
status	string	*
status_date	DateTime	*
setting	array	*
_tags[]	array of objects (Tag)	*
_tags[][name]	string	*
_tags[][slug]	string	*
_tags[][description]	string	*
_tags[][color]	string	*
_tags[][created]	DateTime	*
_tags[][updated]	DateTime	*
_campaign	object (Campaign)	*
_campaign[name]	string	*
_campaign[description]	string	*
_campaign[start_date]	DateTime	*
_campaign[end_date]	DateTime	*
_campaign[is_active]	boolean	*
_campaign[schemaless_config]	string	*
_campaign[created]	DateTime	*
_campaign[updated]	DateTime	*
_campaign[slug]	string	*
_campaign[total_advocates]	integer	*
_campaign[startDate]	DateTime	*
_campaign[endDate]	DateTime	*
_campaign[isActive]	bool	*
_campaign[schemalessConfig]		*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/bonuses

Create a bonus

Documentation
Sandbox

Documentation

Process a referral (advocate_token) and tries to reward the referrer advocate with a bonus based on the rules defined in the campaign. All restrictions set on the campaigns for this account will be checked before giving the bonus to the referrer. Note that a bonus will be given only if all rules defined in the campaign pass validation. The trace of this request can be found on the (GET /accounts/{account_slug}/bonuses/traces) resource.

Request Format

Not all parameters in the content of the request are mandatory. Parameters payment_amount, status, campaign_slug and tags are optional.

{
    "bonus":{
        "advocate_token":"7c4ae87701ef6e6c9ab64941215da6b1f90f5c7a",
        "reference": "HSY7292D00",
        "payment_amount": 10,
        "status":"pending",
        "campaign_slug": "get-10-of-for-90-days-1",
        "tags": ["marketing", "sports"]
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/checkup

GET /accounts/{account_slug}/bonuses/checkup

Check for bonus

Documentation
Sandbox

Documentation

Process a referral (advocate_token) and check if the referrer advocate will be rewarded with a bonus.

Allows the clients to check if there is a bonus to be given, it simulates the behaivor of POST /accounts/{account_slug}/bonuses resource.

This resource is idempotent.

Request Format

 {
    "advocate_token":"7c4ae87701ef6e6c9ab64941215da6b1f90f5c7a",
    "reference": "HSY7292D00",
    "payment_amount": 10,
    "campaign_slug": "get-10-of-for-90-days-1"
  }

Response Format

{
    "code": 200,
    "data": {
        "advocate_referrer_token": "3dc875d4ae1dc46d78828bef4dae586bdb3d8c9d",
        "advocate_token": "c66ecb4255941e83112838a677c2def09f44fc40",
        "bonus_amount": 3,
        "campaign_slug": "get-5-on-first-order-1",
        "message": "The bonus was given to the advocate's referrer.",
        "reference": "HSY7292D00",
        "result": "success",
        "trace": [
            "Campaign is active -> ok",
            "Amount of days after sign up -> ok",
            "Amount of payments -> ok",
            "Payment minimum value per currency -> ok",
            "Maximum value per advocates referrer per currency -> ok",
            "Giving '3.00 USD' bonus to the advocate's referrer -> ok",
            "Give bonus to the advocate's referrer -> ok"
        ]
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

advocate_token

Requirement	.+
Description	The token of the advocate to be processed.

reference

Requirement	.+
Description	The reference code for this request. Useful for linking the request with the user data, reconciliation, etc.

payment_amount

Requirement	.+
Description	The payment amount. Useful for campaigns based in percentage.

campaign_slug

Requirement	.+
Description	The slug of the campaign used to give the bonus

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/force

POST /accounts/{account_slug}/bonuses/force

Create a bonus

Documentation
Sandbox

Documentation

Force the system to give a bonus to an advocate.

The system will not take into account the restrictions specified on the campaigns.

Request Format

Not all parameters in the content of the request are mandatory. Parameter status and tags are optional.

{
    "bonus":{
        "advocate_token":"7c4ae87701ef6e6c9ab64941215da6b1f90f5c7a",
        "reference": "HSY7292D00",
        "bonus_amount": 10,
        "status":"pending",
        "tags": ["marketing", "sports"]
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/traces

GET /accounts/{account_slug}/bonuses/traces

Get bonuses traces

Documentation
Sandbox

Documentation

Get the list of bonuses traces.

Response Format

{
  "code": 200,
  "data": {
    "page": 1,
    "limit": 1,
    "total": 24,
    "results": [
      {
        "id": 14,
        "trace": "trace data",
        "message": "Message",
        "reference": "14587962",
        "created": "2014-02-27T01:36:42+0000",
        "updated": "2014-02-27T01:36:42+0000",
        "advocate_referrer_token": "43277f772ba9a01e485c4641132be8ed6521a09b",
        "advocate_token": "14985d98c28bd32bd5142e0df11b003398fddc47",
        "bonuses": ▿[
         {
             "id": 462,
             "amount": 5,
             "created": "2017-07-15T02:56:34+0000",
             "updated": "2017-07-15T02:56:34+0000",
             "_currency": {
                 "code": "EUR",
                 "unicode": "8364",
                 "currency": "Euro",
                 "suffix": "¢",
                 "updated": "2017-06-22T04:06:22+0000"
             },
             "_advocate": {
                 "email": "advocate123@example.com",
                 "lastname": "asdf",
                 "firstname": "Advocate 123",
                 "token": "363ff3436c50c29bb2507708c17df346f8c9d549",
                 "short_token": "Qy3Ov",
                 "payout_threshold": 5,
                 "claimed_balance": 0,
                 "unclaimed_balance": 465,
                 "total_referrals": 1,
                 "total_bonuses": 6,
                 "created": "2017-07-09T03:05:59+0000",
                 "can_refer": true,
                 "_currency": {
                     "code": "EUR",
                     "unicode": "8364",
                     "currency": "Euro",
                     "suffix": "¢",
                     "updated": "2017-06-22T04:06:22+0000"
                     },
                 "_bonuses_redemption_method": {
                     "name": "Auto into credit",
                     "description": "Automatically exchange the bonuses as credit",
                     "slug": "auto-into-credit"
                     }
                 },
                 "referred_advocate_token": "1d019cab9f586265116ec6d1e74307183a6127af",
                 "referred_advocate_full_name": "Referral 123 asdf",
                 "referred_advocate_email": "referral123@example.com",
                 "reference": "124",
                 "payment_amount": 124
                 }
             }
         ],
        "campaign_slug": "get-1-on-first-order",
        "bonus_amount": 1,
        "result": "success"
      }
    ],
  }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: reference, result, bonus_amount, advocate_token, advocate_referrer_token, advocate_email, referral_email, campaign_slug, from, to, created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
trace	string	*
message	string	*
reference	string	*
created	DateTime	*
updated	DateTime	*
advocate_referrer_token	string	*
advocate_token	string	*
campaign_slug	string	*
bonus_amount	float	*
result	string	*
bonuses[]	array of objects (Bonus)	*
bonuses[][id]	integer	*
bonuses[][amount]	float	*
bonuses[][created]	DateTime	*
bonuses[][updated]	DateTime	*
bonuses[][_currency]	object (Currency)	*
bonuses[][_currency][code]	string	*
bonuses[][_currency][unicode]	string	*
bonuses[][_currency][currency]	string	*
bonuses[][_currency][suffix]	string	*
bonuses[][_currency][updated]	DateTime	*
bonuses[][_advocate]	object (Advocate)	*
bonuses[][_advocate][email]	string	*
bonuses[][_advocate][lastname]	string	*
bonuses[][_advocate][name]	string	*
bonuses[][_advocate][token]	string	*
bonuses[][_advocate][short_token]	string	*
bonuses[][_advocate][code]	string	*
bonuses[][_advocate][payout_threshold]	float	*
bonuses[][_advocate][claimed_balance]	float	*
bonuses[][_advocate][unclaimed_balance]	float	*
bonuses[][_advocate][total_referrals]	integer	*
bonuses[][_advocate][total_bonuses]	integer	*
bonuses[][_advocate][created]	DateTime	*
bonuses[][_advocate][updated]	DateTime	*
bonuses[][_advocate][total_clicks]	integer	*
bonuses[][_advocate][total_shares]	integer	*
bonuses[][_advocate][avatar_url]	string	*
bonuses[][_advocate][metadata]	string	*
bonuses[][_advocate][can_refer]	boolean	*
bonuses[][_advocate][status]	string	*
bonuses[][_advocate][status_date]	DateTime	*
bonuses[][_advocate][setting]	array	*
bonuses[][_advocate][is_email_confirmed]	boolean	*
bonuses[][_advocate][fraudulent]	boolean	*
bonuses[][_advocate][_advocate_referrer]	object (Advocate)	*
bonuses[][_advocate][_currency]	object (Currency)	*
bonuses[][_advocate][_bonuses_redemption_method]	object (BonusExchangeMethod)	*
bonuses[][_advocate][_bonuses_redemption_method][name]	string	*
bonuses[][_advocate][_bonuses_redemption_method][description]	string	*
bonuses[][_advocate][_bonuses_redemption_method][slug]	string	*
bonuses[][_advocate][_campaign_contract]	object (Campaign)	*
bonuses[][_advocate][_campaign_contract][name]	string	*
bonuses[][_advocate][_campaign_contract][description]	string	*
bonuses[][_advocate][_campaign_contract][start_date]	DateTime	*
bonuses[][_advocate][_campaign_contract][end_date]	DateTime	*
bonuses[][_advocate][_campaign_contract][is_active]	boolean	*
bonuses[][_advocate][_campaign_contract][schemaless_config]	string	*
bonuses[][_advocate][_campaign_contract][created]	DateTime	*
bonuses[][_advocate][_campaign_contract][updated]	DateTime	*
bonuses[][_advocate][_campaign_contract][slug]	string	*
bonuses[][_advocate][_campaign_contract][total_advocates]	integer	*
bonuses[][_advocate][_campaign_contract][startDate]	DateTime	*
bonuses[][_advocate][_campaign_contract][endDate]	DateTime	*
bonuses[][_advocate][_campaign_contract][isActive]	bool	*
bonuses[][_advocate][_campaign_contract][schemalessConfig]		*
bonuses[][_advocate][_campaign]	object (Campaign)	*
bonuses[][_referred_advocate]	object (Advocate)	*
bonuses[][bonus_request_trace]	object (BonusRequestTrace)	*
bonuses[][bonus_request_trace][id]	integer	*
bonuses[][bonus_request_trace][trace]	string	*
bonuses[][bonus_request_trace][message]	string	*
bonuses[][bonus_request_trace][reference]	string	*
bonuses[][bonus_request_trace][created]	DateTime	*
bonuses[][bonus_request_trace][updated]	DateTime	*
bonuses[][bonus_request_trace][advocate_referrer_token]	string	*
bonuses[][bonus_request_trace][advocate_token]	string	*
bonuses[][bonus_request_trace][campaign_slug]	string	*
bonuses[][bonus_request_trace][bonus_amount]	float	*
bonuses[][bonus_request_trace][result]	string	*
bonuses[][bonus_request_trace][bonuses][]	array of objects (Bonus)	*
bonuses[][referred_advocate_token]	string	*
bonuses[][referred_advocate_full_name]	string	*
bonuses[][referred_advocate_email]	string	*
bonuses[][referred_advocate_currency_code]	string	*
bonuses[][referred_advocate_can_refer]	boolean	*
bonuses[][redemption_request_id]	integer	*
bonuses[][_bonus_type]	object (BonusType)	*
bonuses[][_bonus_type][name]	string	*
bonuses[][_bonus_type][description]	string	*
bonuses[][_bonus_type][slug]	string	*
bonuses[][reference]	string	*
bonuses[][payment_amount]	float	*
bonuses[][status]	string	*
bonuses[][status_date]	DateTime	*
bonuses[][setting]	array	*
bonuses[][_tags][]	array of objects (Tag)	*
bonuses[][_tags][][name]	string	*
bonuses[][_tags][][slug]	string	*
bonuses[][_tags][][description]	string	*
bonuses[][_tags][][color]	string	*
bonuses[][_tags][][created]	DateTime	*
bonuses[][_tags][][updated]	DateTime	*
bonuses[][_campaign]	object (Campaign)	*
bonuses[][_campaign][name]	string	*
bonuses[][_campaign][description]	string	*
bonuses[][_campaign][start_date]	DateTime	*
bonuses[][_campaign][end_date]	DateTime	*
bonuses[][_campaign][is_active]	boolean	*
bonuses[][_campaign][schemaless_config]	string	*
bonuses[][_campaign][created]	DateTime	*
bonuses[][_campaign][updated]	DateTime	*
bonuses[][_campaign][slug]	string	*
bonuses[][_campaign][total_advocates]	integer	*
bonuses[][_campaign][startDate]	DateTime	*
bonuses[][_campaign][endDate]	DateTime	*
bonuses[][_campaign][isActive]	bool	*
bonuses[][_campaign][schemalessConfig]		*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/traces/{trace_id}

GET /accounts/{account_slug}/bonuses/traces/{trace_id}

Get a bonus request trace

Documentation
Sandbox

Documentation

Get a bonus request trace.

Response Format

{
  "code": 200,
  "data": {
    "id": 11,
    "trace": "trace data",
    "message": "Message",
    "reference": "14587962",
    "created": "2014-02-27T01:36:41+0000",
    "updated": "2014-02-27T01:36:41+0000",
    "advocate_referrer_token": "43277f772ba9a01e485c4641132be8ed6521a09b",
    "advocate_token": "14985d98c28bd32bd5142e0df11b003398fddc47",
     "bonuses": ▿[
         {
             "id": 462,
             "amount": 5,
             "created": "2017-07-15T02:56:34+0000",
             "updated": "2017-07-15T02:56:34+0000",
             "_currency": {
                 "code": "EUR",
                 "unicode": "8364",
                 "currency": "Euro",
                 "suffix": "¢",
                 "updated": "2017-06-22T04:06:22+0000"
             },
             "_advocate": {
                 "email": "advocate123@example.com",
                 "lastname": "asdf",
                 "firstname": "Advocate 123",
                 "token": "363ff3436c50c29bb2507708c17df346f8c9d549",
                 "short_token": "Qy3Ov",
                 "payout_threshold": 5,
                 "claimed_balance": 0,
                 "unclaimed_balance": 465,
                 "total_referrals": 1,
                 "total_bonuses": 6,
                 "created": "2017-07-09T03:05:59+0000",
                 "can_refer": true,
                 "_currency": {
                     "code": "EUR",
                     "unicode": "8364",
                     "currency": "Euro",
                     "suffix": "¢",
                     "updated": "2017-06-22T04:06:22+0000"
                 },
                 "_bonuses_redemption_method": {
                     "name": "Auto into credit",
                     "description": "Automatically exchange the bonuses as credit",
                     "slug": "auto-into-credit"
                     }
                 },
                 "referred_advocate_token": "1d019cab9f586265116ec6d1e74307183a6127af",
                 "referred_advocate_full_name": "Referral 123 asdf",
                 "referred_advocate_email": "referral123@example.com",
                 "reference": "124",
                 "payment_amount": 124
             }
         }
     ],
    "campaign_slug": "get-1-on-first-order",
    "bonus_amount": 1,
    "result": "success"
  }
}

Requirements

Name	Requirement	Type	Description
trace_id	\d+	string	the trace id
account_slug		string	the client account slug

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
trace	string	*
message	string	*
reference	string	*
created	DateTime	*
updated	DateTime	*
advocate_referrer_token	string	*
advocate_token	string	*
campaign_slug	string	*
bonus_amount	float	*
result	string	*
bonuses[]	array of objects (Bonus)	*
bonuses[][id]	integer	*
bonuses[][amount]	float	*
bonuses[][created]	DateTime	*
bonuses[][updated]	DateTime	*
bonuses[][_currency]	object (Currency)	*
bonuses[][_currency][code]	string	*
bonuses[][_currency][unicode]	string	*
bonuses[][_currency][currency]	string	*
bonuses[][_currency][suffix]	string	*
bonuses[][_currency][updated]	DateTime	*
bonuses[][_advocate]	object (Advocate)	*
bonuses[][_advocate][email]	string	*
bonuses[][_advocate][lastname]	string	*
bonuses[][_advocate][name]	string	*
bonuses[][_advocate][token]	string	*
bonuses[][_advocate][short_token]	string	*
bonuses[][_advocate][code]	string	*
bonuses[][_advocate][payout_threshold]	float	*
bonuses[][_advocate][claimed_balance]	float	*
bonuses[][_advocate][unclaimed_balance]	float	*
bonuses[][_advocate][total_referrals]	integer	*
bonuses[][_advocate][total_bonuses]	integer	*
bonuses[][_advocate][created]	DateTime	*
bonuses[][_advocate][updated]	DateTime	*
bonuses[][_advocate][total_clicks]	integer	*
bonuses[][_advocate][total_shares]	integer	*
bonuses[][_advocate][avatar_url]	string	*
bonuses[][_advocate][metadata]	string	*
bonuses[][_advocate][can_refer]	boolean	*
bonuses[][_advocate][status]	string	*
bonuses[][_advocate][status_date]	DateTime	*
bonuses[][_advocate][setting]	array	*
bonuses[][_advocate][is_email_confirmed]	boolean	*
bonuses[][_advocate][fraudulent]	boolean	*
bonuses[][_advocate][_advocate_referrer]	object (Advocate)	*
bonuses[][_advocate][_currency]	object (Currency)	*
bonuses[][_advocate][_bonuses_redemption_method]	object (BonusExchangeMethod)	*
bonuses[][_advocate][_bonuses_redemption_method][name]	string	*
bonuses[][_advocate][_bonuses_redemption_method][description]	string	*
bonuses[][_advocate][_bonuses_redemption_method][slug]	string	*
bonuses[][_advocate][_campaign_contract]	object (Campaign)	*
bonuses[][_advocate][_campaign_contract][name]	string	*
bonuses[][_advocate][_campaign_contract][description]	string	*
bonuses[][_advocate][_campaign_contract][start_date]	DateTime	*
bonuses[][_advocate][_campaign_contract][end_date]	DateTime	*
bonuses[][_advocate][_campaign_contract][is_active]	boolean	*
bonuses[][_advocate][_campaign_contract][schemaless_config]	string	*
bonuses[][_advocate][_campaign_contract][created]	DateTime	*
bonuses[][_advocate][_campaign_contract][updated]	DateTime	*
bonuses[][_advocate][_campaign_contract][slug]	string	*
bonuses[][_advocate][_campaign_contract][total_advocates]	integer	*
bonuses[][_advocate][_campaign_contract][startDate]	DateTime	*
bonuses[][_advocate][_campaign_contract][endDate]	DateTime	*
bonuses[][_advocate][_campaign_contract][isActive]	bool	*
bonuses[][_advocate][_campaign_contract][schemalessConfig]		*
bonuses[][_advocate][_campaign]	object (Campaign)	*
bonuses[][_referred_advocate]	object (Advocate)	*
bonuses[][bonus_request_trace]	object (BonusRequestTrace)	*
bonuses[][bonus_request_trace][id]	integer	*
bonuses[][bonus_request_trace][trace]	string	*
bonuses[][bonus_request_trace][message]	string	*
bonuses[][bonus_request_trace][reference]	string	*
bonuses[][bonus_request_trace][created]	DateTime	*
bonuses[][bonus_request_trace][updated]	DateTime	*
bonuses[][bonus_request_trace][advocate_referrer_token]	string	*
bonuses[][bonus_request_trace][advocate_token]	string	*
bonuses[][bonus_request_trace][campaign_slug]	string	*
bonuses[][bonus_request_trace][bonus_amount]	float	*
bonuses[][bonus_request_trace][result]	string	*
bonuses[][bonus_request_trace][bonuses][]	array of objects (Bonus)	*
bonuses[][referred_advocate_token]	string	*
bonuses[][referred_advocate_full_name]	string	*
bonuses[][referred_advocate_email]	string	*
bonuses[][referred_advocate_currency_code]	string	*
bonuses[][referred_advocate_can_refer]	boolean	*
bonuses[][redemption_request_id]	integer	*
bonuses[][_bonus_type]	object (BonusType)	*
bonuses[][_bonus_type][name]	string	*
bonuses[][_bonus_type][description]	string	*
bonuses[][_bonus_type][slug]	string	*
bonuses[][reference]	string	*
bonuses[][payment_amount]	float	*
bonuses[][status]	string	*
bonuses[][status_date]	DateTime	*
bonuses[][setting]	array	*
bonuses[][_tags][]	array of objects (Tag)	*
bonuses[][_tags][][name]	string	*
bonuses[][_tags][][slug]	string	*
bonuses[][_tags][][description]	string	*
bonuses[][_tags][][color]	string	*
bonuses[][_tags][][created]	DateTime	*
bonuses[][_tags][][updated]	DateTime	*
bonuses[][_campaign]	object (Campaign)	*
bonuses[][_campaign][name]	string	*
bonuses[][_campaign][description]	string	*
bonuses[][_campaign][start_date]	DateTime	*
bonuses[][_campaign][end_date]	DateTime	*
bonuses[][_campaign][is_active]	boolean	*
bonuses[][_campaign][schemaless_config]	string	*
bonuses[][_campaign][created]	DateTime	*
bonuses[][_campaign][updated]	DateTime	*
bonuses[][_campaign][slug]	string	*
bonuses[][_campaign][total_advocates]	integer	*
bonuses[][_campaign][startDate]	DateTime	*
bonuses[][_campaign][endDate]	DateTime	*
bonuses[][_campaign][isActive]	bool	*
bonuses[][_campaign][schemalessConfig]		*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/{bonus_id}

DELETE /accounts/{account_slug}/bonuses/{bonus_id}

Delete a bonus

Documentation
Sandbox

Documentation

Delete a bonus.

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
bonus_id		string	the bonus id

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/bonuses/{bonus_id}

Get a bonus

Documentation
Sandbox

Documentation

Get a bonus by a given id.

Response Format

{
    "code": 200,
    "data": {
        "_advocate": {
            "_bonuses_redemption_method": {
                "description": "Automatically redeem the bonuses as credit",
                "name": "Auto into credit",
                "slug": "auto-into-credit"
            },
            "_currency": {
                "code": "USD",
                "currency": "United States Dollar",
                "suffix": "¢",
                "unicode": "32"
            },
            "claimed_balance": 0,
            "created": "2014-01-15T05:32:06+0000",
            "email": "advocate_at_mail.com",
            "lastname": "Hernandez",
            "firstname": "Advocate",
            "payout_threshold": 10,
            "token": "204ba2a0e21408890995a747544f5fb31f4250c3",
            "unclaimed_balance": 0
        },
        "_currency": {
            "code": "USD",
            "currency": "United States Dollar",
            "suffix": "¢",
            "unicode": "32"
        },
         bonus_request_trace: {
             "id": 14,
             "trace": "trace data",
             "message": "Message",
             "reference": "14587962",
             "created": "2014-02-27T01:36:42+0000",
             "updated": "2014-02-27T01:36:42+0000",
             "advocate_referrer_token": "43277f772ba9a01e485c4641132be8ed6521a09b",
             "advocate_token": "14985d98c28bd32bd5142e0df11b003398fddc47",
             "bonuses" : [],
             "campaign_slug": "get-1-on-first-order",
             "bonus_amount": 1,
             "result": "success"
         },
        "amount": 10,
        "referred_advocate_email":"erica@gmail.com",
        "referred_advocate_full_name":"Erica Chagas",
        "created": "2014-01-15T05:32:06+0000",
        "id": 109,
        "referred_advocate_token": "9177c43afde9d95725fed931b8ab9ce7128fa82a",
        "payment_amount": 12.3,
        "reference":"XRE3456",
        "status":"pending",
        "status_date": "2019-05-15T03:51:42+00:00",
        "setting": {
            "statusLogs": "[{\"status\":\"pending\",\"date\":\"2019-05-15 03:51:42\"}]"
        }
    }
}

Requirements

Name	Requirement	Type	Description
bonus_id	\d+	string	the bonus id
account_slug		string	the client account slug

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
amount	float	*
created	DateTime	*
updated	DateTime	*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_advocate	object (Advocate)	*
_advocate[email]	string	*
_advocate[lastname]	string	*
_advocate[name]	string	*
_advocate[token]	string	*
_advocate[short_token]	string	*
_advocate[code]	string	*
_advocate[payout_threshold]	float	*
_advocate[claimed_balance]	float	*
_advocate[unclaimed_balance]	float	*
_advocate[total_referrals]	integer	*
_advocate[total_bonuses]	integer	*
_advocate[created]	DateTime	*
_advocate[updated]	DateTime	*
_advocate[total_clicks]	integer	*
_advocate[total_shares]	integer	*
_advocate[avatar_url]	string	*
_advocate[metadata]	string	*
_advocate[can_refer]	boolean	*
_advocate[status]	string	*
_advocate[status_date]	DateTime	*
_advocate[setting]	array	*
_advocate[is_email_confirmed]	boolean	*
_advocate[fraudulent]	boolean	*
_advocate[_advocate_referrer]	object (Advocate)	*
_advocate[_currency]	object (Currency)	*
_advocate[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate[_bonuses_redemption_method][name]	string	*
_advocate[_bonuses_redemption_method][description]	string	*
_advocate[_bonuses_redemption_method][slug]	string	*
_advocate[_campaign_contract]	object (Campaign)	*
_advocate[_campaign_contract][name]	string	*
_advocate[_campaign_contract][description]	string	*
_advocate[_campaign_contract][start_date]	DateTime	*
_advocate[_campaign_contract][end_date]	DateTime	*
_advocate[_campaign_contract][is_active]	boolean	*
_advocate[_campaign_contract][schemaless_config]	string	*
_advocate[_campaign_contract][created]	DateTime	*
_advocate[_campaign_contract][updated]	DateTime	*
_advocate[_campaign_contract][slug]	string	*
_advocate[_campaign_contract][total_advocates]	integer	*
_advocate[_campaign_contract][startDate]	DateTime	*
_advocate[_campaign_contract][endDate]	DateTime	*
_advocate[_campaign_contract][isActive]	bool	*
_advocate[_campaign_contract][schemalessConfig]		*
_advocate[_campaign]	object (Campaign)	*
_referred_advocate	object (Advocate)	*
bonus_request_trace	object (BonusRequestTrace)	*
bonus_request_trace[id]	integer	*
bonus_request_trace[trace]	string	*
bonus_request_trace[message]	string	*
bonus_request_trace[reference]	string	*
bonus_request_trace[created]	DateTime	*
bonus_request_trace[updated]	DateTime	*
bonus_request_trace[advocate_referrer_token]	string	*
bonus_request_trace[advocate_token]	string	*
bonus_request_trace[campaign_slug]	string	*
bonus_request_trace[bonus_amount]	float	*
bonus_request_trace[result]	string	*
bonus_request_trace[bonuses][]	array of objects (Bonus)	*
bonus_request_trace[bonuses][][id]	integer	*
bonus_request_trace[bonuses][][amount]	float	*
bonus_request_trace[bonuses][][created]	DateTime	*
bonus_request_trace[bonuses][][updated]	DateTime	*
bonus_request_trace[bonuses][][_currency]	object (Currency)	*
bonus_request_trace[bonuses][][_advocate]	object (Advocate)	*
bonus_request_trace[bonuses][][_referred_advocate]	object (Advocate)	*
bonus_request_trace[bonuses][][bonus_request_trace]	object (BonusRequestTrace)	*
bonus_request_trace[bonuses][][referred_advocate_token]	string	*
bonus_request_trace[bonuses][][referred_advocate_full_name]	string	*
bonus_request_trace[bonuses][][referred_advocate_email]	string	*
bonus_request_trace[bonuses][][referred_advocate_currency_code]	string	*
bonus_request_trace[bonuses][][referred_advocate_can_refer]	boolean	*
bonus_request_trace[bonuses][][redemption_request_id]	integer	*
bonus_request_trace[bonuses][][_bonus_type]	object (BonusType)	*
bonus_request_trace[bonuses][][_bonus_type][name]	string	*
bonus_request_trace[bonuses][][_bonus_type][description]	string	*
bonus_request_trace[bonuses][][_bonus_type][slug]	string	*
bonus_request_trace[bonuses][][reference]	string	*
bonus_request_trace[bonuses][][payment_amount]	float	*
bonus_request_trace[bonuses][][status]	string	*
bonus_request_trace[bonuses][][status_date]	DateTime	*
bonus_request_trace[bonuses][][setting]	array	*
bonus_request_trace[bonuses][][_tags][]	array of objects (Tag)	*
bonus_request_trace[bonuses][][_tags][][name]	string	*
bonus_request_trace[bonuses][][_tags][][slug]	string	*
bonus_request_trace[bonuses][][_tags][][description]	string	*
bonus_request_trace[bonuses][][_tags][][color]	string	*
bonus_request_trace[bonuses][][_tags][][created]	DateTime	*
bonus_request_trace[bonuses][][_tags][][updated]	DateTime	*
bonus_request_trace[bonuses][][_campaign]	object (Campaign)	*
bonus_request_trace[bonuses][][_campaign][name]	string	*
bonus_request_trace[bonuses][][_campaign][description]	string	*
bonus_request_trace[bonuses][][_campaign][start_date]	DateTime	*
bonus_request_trace[bonuses][][_campaign][end_date]	DateTime	*
bonus_request_trace[bonuses][][_campaign][is_active]	boolean	*
bonus_request_trace[bonuses][][_campaign][schemaless_config]	string	*
bonus_request_trace[bonuses][][_campaign][created]	DateTime	*
bonus_request_trace[bonuses][][_campaign][updated]	DateTime	*
bonus_request_trace[bonuses][][_campaign][slug]	string	*
bonus_request_trace[bonuses][][_campaign][total_advocates]	integer	*
bonus_request_trace[bonuses][][_campaign][startDate]	DateTime	*
bonus_request_trace[bonuses][][_campaign][endDate]	DateTime	*
bonus_request_trace[bonuses][][_campaign][isActive]	bool	*
bonus_request_trace[bonuses][][_campaign][schemalessConfig]		*
referred_advocate_token	string	*
referred_advocate_full_name	string	*
referred_advocate_email	string	*
referred_advocate_currency_code	string	*
referred_advocate_can_refer	boolean	*
redemption_request_id	integer	*
_bonus_type	object (BonusType)	*
_bonus_type[name]	string	*
_bonus_type[description]	string	*
_bonus_type[slug]	string	*
reference	string	*
payment_amount	float	*
status	string	*
status_date	DateTime	*
setting	array	*
_tags[]	array of objects (Tag)	*
_tags[][name]	string	*
_tags[][slug]	string	*
_tags[][description]	string	*
_tags[][color]	string	*
_tags[][created]	DateTime	*
_tags[][updated]	DateTime	*
_campaign	object (Campaign)	*
_campaign[name]	string	*
_campaign[description]	string	*
_campaign[start_date]	DateTime	*
_campaign[end_date]	DateTime	*
_campaign[is_active]	boolean	*
_campaign[schemaless_config]	string	*
_campaign[created]	DateTime	*
_campaign[updated]	DateTime	*
_campaign[slug]	string	*
_campaign[total_advocates]	integer	*
_campaign[startDate]	DateTime	*
_campaign[endDate]	DateTime	*
_campaign[isActive]	bool	*
_campaign[schemalessConfig]		*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /accounts/{account_slug}/bonuses/{bonus_id}

Update a bonus

Documentation
Sandbox

Documentation

Update partial elements of a bonus. Use this method when you do not need to update all the elements at the same time.

Allowed parameters to be updated are: status and reason.

Request Format

{
"status": "denied",
"reason": "The reason",
"tags": ["marketing","sports"]
}

Requirements

Name	Requirement	Type	Description
id	\d+
bonus_id	\d+	string	the bonus id
account_slug		string	the client account slug

Status Codes

Status Code	Description
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/{bonus_id}/tags

POST /accounts/{account_slug}/bonuses/{bonus_id}/tags

Add a tag

Documentation
Sandbox

Documentation

Add a tag to the given bonus.

Request Format

All parameters in the content of the request are mandatory.

  {
      "bonus" : {
          "tag": {
              "slug":"marketing"
          }
     }
  }

Requirements

Name	Requirement	Type	Description
bonus_id	\d+	integer	the bonus_id id
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/bonuses/{bonus_id}/tags/{tag_slug}

DELETE /accounts/{account_slug}/bonuses/{bonus_id}/tags/{tag_slug}

Delete a tag

Documentation
Sandbox

Documentation

Delete a tag from the given bonus.

Requirements

Name	Requirement	Type	Description
bonus_id	\d+	string	the bonus id
account_slug		string	the client account slug
tag_slug		string	the tag slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Campaigns

/accounts/{account_slug}/campaigns

GET /accounts/{account_slug}/campaigns

Get campaigns

Documentation
Sandbox

Documentation

Get the list of campaings for a given account.

Response Format

 {
    "code": 200,
    "data": {
        "limit": 10,
        "page": 1,
        "results": [
            {
                "created": "2013-12-15T04:01:09+0000",
                "description": "Get 10% of for 90 days",
                "is_active": false,
                "name": "Get 10% of for 90 days",
                "slug": "get-10-of-for-90-days-1",
                "start_date": "2013-12-16T00:00:00+0000",
                "total_advocates": 2,
                "updated": "2014-02-01T20:47:35+0000"
            }
        ],
        "total": 1
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: name, description, start_date, end_date, is_active (true|false), created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: campaign_slug, created, start_date, end_date, is_active. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
startDate	DateTime	*
endDate	DateTime	*
isActive	bool	*
schemalessConfig		*
start_date	DateTime	*
end_date	DateTime	*
is_active	boolean	*
schemaless_config	string	*
created	DateTime	*
updated	DateTime	*
slug	string	*
total_advocates	integer	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/campaigns/{campaign_slug}

GET /accounts/{account_slug}/campaigns/{campaign_slug}

Get a campaign

Documentation
Sandbox

Documentation

Get a campaign by a given slug.

Response Format

{
    "code": 200,
    "data": {
        "created": "2013-12-15T04:01:09+0000",
        "description": "Get 10% of for 90 days",
        "is_active": false,
        "name": "Get 10% of for 90 days",
        "slug": "get-10-of-for-90-days-1",
        "start_date": "2013-12-16T00:00:00+0000",
        "total_advocates": 2,
        "updated": "2014-02-01T20:47:35+0000"
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
campaign_slug		string	the campaign slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
startDate	DateTime	*
endDate	DateTime	*
isActive	bool	*
schemalessConfig		*
start_date	DateTime	*
end_date	DateTime	*
is_active	boolean	*
schemaless_config	string	*
created	DateTime	*
updated	DateTime	*
slug	string	*
total_advocates	integer	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Products

/accounts/{account_slug}/products

GET /accounts/{account_slug}/products

Get products

Documentation
Sandbox

Documentation

Get the list of products for a given program.

Response Format

{
    "code": 200,
    "data": {
        "page": 1,
        "limit": 10,
        "total": 1,
        "results": [
            {
                "title": "Iphone 8",
                "slug": "iphone-8",
                "description": "Latest iphone on the market",
                "images": [
                    "http://www.yourimage.url/123.png",
                    "http://www.yourimage.url/124.png"
                ],
                "setting": {
                    "statusLogs": "[{\"status\":\"open\",\"statusId\":1,\"date\":\"2019-09-29 19:29:56\"}]"
                },
                "_variants": [
                    {
                        "id": 1,
                        "title": "Iphone 8 x230-ds",
                        "inventory_quantity": 1000,
                        "barcode": "839384028",
                        "sku": "839384028",
                        "features":"The features",
                        "created": "2019-09-29T19:29:56+0000",
                        "updated": "2019-09-29T19:29:56+0000",
                        "_price": {
                            "amount": 99.99,
                            "created": "2019-10-08T00:13:00+0000",
                            "updated": "2019-10-08T00:13:00+0000",
                            "_currency": {
                                "code": "USD",
                                "unicode": "32",
                                "currency": "United States Dollar",
                                "suffix": "¢",
                                "updated": "2019-08-19T22:00:55+0000"
                            }
                        }
                    }
                ],
                "created": "2019-09-29T19:29:56+0000",
                "updated": "2019-09-29T19:29:56+0000",
                "_product_status": {
                    "name": "Open",
                    "slug": "open",
                    "description": "Open"
                },
            }
        ]
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: title, product_slug, product_status_slug, created, currency_code. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: title, created, price. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
title	string	*
slug	string	*
description	string	*
images	array	*
setting	array	*
created	DateTime	*
updated	DateTime	*
_variants[]	array of objects (Variant)	*
_variants[][id]	integer	*
_variants[][title]	string	*
_variants[][inventory_quantity]	integer	*
_variants[][barcode]	string	*
_variants[][sku]	string	*
_variants[][features]	string	*
_variants[][created]	DateTime	*
_variants[][updated]	DateTime	*
_variants[][_price]	object (VariantPrice)	*
_variants[][_price][amount]	float	*
_variants[][_price][created]	DateTime	*
_variants[][_price][updated]	DateTime	*
_variants[][_price][_currency]	object (Currency)	*
_variants[][_price][_currency][code]	string	*
_variants[][_price][_currency][unicode]	string	*
_variants[][_price][_currency][currency]	string	*
_variants[][_price][_currency][suffix]	string	*
_variants[][_price][_currency][updated]	DateTime	*
_variants[][_price][_variant]	object (Variant)	*
_variants[][_product]	object (Product)	*
_variants[][_product][title]	string	*
_variants[][_product][slug]	string	*
_variants[][_product][description]	string	*
_variants[][_product][images]	array	*
_variants[][_product][setting]	array	*
_variants[][_product][created]	DateTime	*
_variants[][_product][updated]	DateTime	*
_variants[][_product][_variants][]	array of objects (Variant)	*
_variants[][_product][_product_status]	object (ProductStatus)	*
_variants[][_product][_product_status][name]	string	*
_variants[][_product][_product_status][slug]	string	*
_variants[][_product][_product_status][description]	string	*
_product_status	object (ProductStatus)	*
_product_status[name]	string	*
_product_status[slug]	string	*
_product_status[description]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/products

Create a product

Documentation
Sandbox

Documentation

Create a new product.

Request Format

Not all parameters in the content of the request are mandatory. Parameter variants is optional. Parameter status can be open, published or retired.

 {
     "product": {
         "title":"Iphone 8",
         "description_html" : "Latest iphone on the market",
         "status": "open",
         "images": ["http:\/\/www.yourimage.url\/123.png","http:\/\/www.yourimage.url\/124.png"],
         "variants": [
             {
                 "title": "Iphone 8 x230-ds",
                 "inventory_quantity":1000,
                 "barcode":"839384028",
                 "sku":"839384028",
                 "features":"The features",
                 "price": {
                     "currency_code":"USD",
                     "amount":"99.99"
                 }
             }
         ]
     }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/products/{product_slug}

DELETE /accounts/{account_slug}/products/{product_slug}

Delete a product

Documentation
Sandbox

Documentation

Delete a product

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
product_slug		string	the product slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/products/{product_slug}

Return a product

Documentation
Sandbox

Documentation

Get a product by a given product_slug.

Response Format

 {
     "code": 200,
     "data": {
         "title": "Iphone 8",
         "slug": "iphone-8",
         "description": "Latest iphone on the market",
         "images": [
             "http://www.yourimage.url/123.png",
             "http://www.yourimage.url/124.png"
         ],
         "setting": {
             "statusLogs": "[{\"status\":\"open\",\"statusId\":1,\"date\":\"2019-09-29 19:29:56\"}]"
         },
         "_variants": [
             {
                 "id": 1,
                 "title": "Iphone 8 x230-ds",
                 "inventory_quantity": 1000,
                 "barcode": "839384028",
                 "sku": "839384028",
                 "features":"The features",
                 "created": "2019-09-29T19:29:56+0000",
                 "updated": "2019-09-29T19:29:56+0000",
                 "_price": {
                     "amount": 99.99,
                     "created": "2019-10-08T00:13:00+0000",
                     "updated": "2019-10-08T00:13:00+0000",
                     "_currency": {
                         "code": "USD",
                         "unicode": "32",
                         "currency": "United States Dollar",
                         "suffix": "¢",
                         "updated": "2019-08-19T22:00:55+0000"
                     }
                 }
             }
         ],
         "created": "2019-09-29T19:29:56+0000",
         "updated": "2019-09-29T19:29:56+0000",
         "_product_status": {
             "name": "Open",
             "slug": "open",
             "description": "Open"
         },
     }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
product_slug		string	the product slug

Filters

Name

Information

filter

Requirement

Description

Allowed fields: currency_code. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

Return

Parameter	Type	Versions
200 - Returned when successful
title	string	*
slug	string	*
description	string	*
images	array	*
setting	array	*
created	DateTime	*
updated	DateTime	*
_variants[]	array of objects (Variant)	*
_variants[][id]	integer	*
_variants[][title]	string	*
_variants[][inventory_quantity]	integer	*
_variants[][barcode]	string	*
_variants[][sku]	string	*
_variants[][features]	string	*
_variants[][created]	DateTime	*
_variants[][updated]	DateTime	*
_variants[][_price]	object (VariantPrice)	*
_variants[][_price][amount]	float	*
_variants[][_price][created]	DateTime	*
_variants[][_price][updated]	DateTime	*
_variants[][_price][_currency]	object (Currency)	*
_variants[][_price][_currency][code]	string	*
_variants[][_price][_currency][unicode]	string	*
_variants[][_price][_currency][currency]	string	*
_variants[][_price][_currency][suffix]	string	*
_variants[][_price][_currency][updated]	DateTime	*
_variants[][_price][_variant]	object (Variant)	*
_variants[][_product]	object (Product)	*
_variants[][_product][title]	string	*
_variants[][_product][slug]	string	*
_variants[][_product][description]	string	*
_variants[][_product][images]	array	*
_variants[][_product][setting]	array	*
_variants[][_product][created]	DateTime	*
_variants[][_product][updated]	DateTime	*
_variants[][_product][_variants][]	array of objects (Variant)	*
_variants[][_product][_product_status]	object (ProductStatus)	*
_variants[][_product][_product_status][name]	string	*
_variants[][_product][_product_status][slug]	string	*
_variants[][_product][_product_status][description]	string	*
_product_status	object (ProductStatus)	*
_product_status[name]	string	*
_product_status[slug]	string	*
_product_status[description]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /accounts/{account_slug}/products/{product_slug}

Update a product

Documentation
Sandbox

Documentation

Update partial elements of a product. Use this method when you do not need to update all the elements at the same time.

Allowed parameters to be updated are: title, description_html, status, images

Request Format

 {
     "title":"Iphone 8",
     "description_html" : "Latest iphone on the market",
     "status": "open",
     "images": ["http:\/\/www.yourimage.url\/123.png","http:\/\/www.yourimage.url\/124.png"]
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
product_slug		string	the product slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /accounts/{account_slug}/products/{product_slug}

Update a product

Documentation
Sandbox

Documentation

Update a product.

Request Format

All parameters in the content of the request are mandatory.

 {
     "product": {
         "title":"Iphone 8",
         "description_html" : "Latest iphone on the market",
         "status": "open",
         "images": ["http:\/\/www.yourimage.url\/123.png","http:\/\/www.yourimage.url\/124.png"]
     }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
product_slug		string	the product slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/products/{product_slug}/variants

GET /accounts/{account_slug}/products/{product_slug}/variants

Get variants

Documentation
Sandbox

Documentation

Get the list of variants for a given product.

Response Format

{
    "code": 200,
    "data": {
        "page": 1,
        "limit": 10,
        "total": 1,
        "results": [
            {
                "id": 1,
                "title": "Iphone 8 x230-ds",
                "inventory_quantity": 1000,
                "barcode": "839384028",
                "sku": "839384028",
                "features":"The features",
                "created": "2019-09-29T19:29:56+0000",
                "updated": "2019-09-29T19:29:56+0000",
                "_price": {
                    "amount": 99.99,
                    "created": "2019-10-08T00:13:00+0000",
                    "updated": "2019-10-08T00:13:00+0000",
                    "_currency": {
                        "code": "USD",
                        "unicode": "32",
                        "currency": "United States Dollar",
                        "suffix": "¢",
                        "updated": "2019-08-19T22:00:55+0000"
                    }
                },
                "_product": {
                    "title":"Iphone 8",
                    "description_html" : "Latest iphone on the market",
                    "status": "opened",
                    "images": ["http:\/\/www.yourimage.url\/123.png","http:\/\/www.yourimage.url\/124.png"]
                }
            }
        ]
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
product_slug		integer	the product slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: title, barcode, sku, created, currency_code. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: title, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
title	string	*
inventory_quantity	integer	*
barcode	string	*
sku	string	*
features	string	*
created	DateTime	*
updated	DateTime	*
_price	object (VariantPrice)	*
_price[amount]	float	*
_price[created]	DateTime	*
_price[updated]	DateTime	*
_price[_currency]	object (Currency)	*
_price[_currency][code]	string	*
_price[_currency][unicode]	string	*
_price[_currency][currency]	string	*
_price[_currency][suffix]	string	*
_price[_currency][updated]	DateTime	*
_price[_variant]	object (Variant)	*
_price[_variant][id]	integer	*
_price[_variant][title]	string	*
_price[_variant][inventory_quantity]	integer	*
_price[_variant][barcode]	string	*
_price[_variant][sku]	string	*
_price[_variant][features]	string	*
_price[_variant][created]	DateTime	*
_price[_variant][updated]	DateTime	*
_price[_variant][_price]	object (VariantPrice)	*
_price[_variant][_product]	object (Product)	*
_price[_variant][_product][title]	string	*
_price[_variant][_product][slug]	string	*
_price[_variant][_product][description]	string	*
_price[_variant][_product][images]	array	*
_price[_variant][_product][setting]	array	*
_price[_variant][_product][created]	DateTime	*
_price[_variant][_product][updated]	DateTime	*
_price[_variant][_product][_variants][]	array of objects (Variant)	*
_price[_variant][_product][_product_status]	object (ProductStatus)	*
_price[_variant][_product][_product_status][name]	string	*
_price[_variant][_product][_product_status][slug]	string	*
_price[_variant][_product][_product_status][description]	string	*
_product	object (Product)	*
_product[title]	string	*
_product[slug]	string	*
_product[description]	string	*
_product[images]	array	*
_product[setting]	array	*
_product[created]	DateTime	*
_product[updated]	DateTime	*
_product[_variants][]	array of objects (Variant)	*
_product[_variants][][id]	integer	*
_product[_variants][][title]	string	*
_product[_variants][][inventory_quantity]	integer	*
_product[_variants][][barcode]	string	*
_product[_variants][][sku]	string	*
_product[_variants][][features]	string	*
_product[_variants][][created]	DateTime	*
_product[_variants][][updated]	DateTime	*
_product[_variants][][_price]	object (VariantPrice)	*
_product[_variants][][_product]	object (Product)	*
_product[_product_status]	object (ProductStatus)	*
_product[_product_status][name]	string	*
_product[_product_status][slug]	string	*
_product[_product_status][description]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/products/{product_slug}/variants

Create a variant

Documentation
Sandbox

Documentation

Create a new variant.

Request Format

Not all parameters in the content of the request are mandatory.Parameter features is optional.

 {
     "variant": {
         "title": "Iphone 8 x230-ds",
         "inventory_quantity":800,
         "barcode":"839384029",
         "sku":"839384029",
         "features":"The features",
         "price": {
             "currency_code":"USD",
             "amount":"99.99"
         }
     }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
product_slug		string	the product slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/products/{product_slug}/variants/{variant_id}

DELETE /accounts/{account_slug}/products/{product_slug}/variants/{variant_id}

Delete a variant

Documentation
Sandbox

Documentation

Delete a variant.

Requirements

Name	Requirement	Type	Description
variant_id	\d+	integer	the variant id
account_slug		string	the client account slug
product_slug		string	the product slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/products/{product_slug}/variants/{variant_id}

Return a variant

Documentation
Sandbox

Documentation

Get a variant by the given parameters.

Response Format

{
    "code": 200,
    "data": {
        "id": 24,
        "title": "Iphone 8 x230-ds",
        "inventory_quantity": 1000,
        "barcode": "839384028",
        "sku": "839384028",
        "features":"The features",
        "created": "2019-09-29T19:29:56+0000",
        "updated": "2019-09-29T19:29:56+0000",
        "_price": {
            "amount": 99.99,
            "created": "2019-10-08T00:13:00+0000",
            "updated": "2019-10-08T00:13:00+0000",
            "_currency": {
                "code": "USD",
                "unicode": "32",
                "currency": "United States Dollar",
                "suffix": "¢",
                "updated": "2019-08-19T22:00:55+0000"
            }
        },
        "_product": {
            "title":"Iphone 8",
            "description_html" : "Latest iphone on the market",
            "status": "opened",
            "images": ["http:\/\/www.yourimage.url\/123.png","http:\/\/www.yourimage.url\/124.png"],
        }
    }
}

Requirements

Name	Requirement	Type	Description
variant_id	\d+	string	the variant id
account_slug		string	the client account slug
product_slug		string	the product slug

Filters

Name

Information

filter

Requirement

Description

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
title	string	*
inventory_quantity	integer	*
barcode	string	*
sku	string	*
features	string	*
created	DateTime	*
updated	DateTime	*
_price	object (VariantPrice)	*
_price[amount]	float	*
_price[created]	DateTime	*
_price[updated]	DateTime	*
_price[_currency]	object (Currency)	*
_price[_currency][code]	string	*
_price[_currency][unicode]	string	*
_price[_currency][currency]	string	*
_price[_currency][suffix]	string	*
_price[_currency][updated]	DateTime	*
_price[_variant]	object (Variant)	*
_price[_variant][id]	integer	*
_price[_variant][title]	string	*
_price[_variant][inventory_quantity]	integer	*
_price[_variant][barcode]	string	*
_price[_variant][sku]	string	*
_price[_variant][features]	string	*
_price[_variant][created]	DateTime	*
_price[_variant][updated]	DateTime	*
_price[_variant][_price]	object (VariantPrice)	*
_price[_variant][_product]	object (Product)	*
_price[_variant][_product][title]	string	*
_price[_variant][_product][slug]	string	*
_price[_variant][_product][description]	string	*
_price[_variant][_product][images]	array	*
_price[_variant][_product][setting]	array	*
_price[_variant][_product][created]	DateTime	*
_price[_variant][_product][updated]	DateTime	*
_price[_variant][_product][_variants][]	array of objects (Variant)	*
_price[_variant][_product][_product_status]	object (ProductStatus)	*
_price[_variant][_product][_product_status][name]	string	*
_price[_variant][_product][_product_status][slug]	string	*
_price[_variant][_product][_product_status][description]	string	*
_product	object (Product)	*
_product[title]	string	*
_product[slug]	string	*
_product[description]	string	*
_product[images]	array	*
_product[setting]	array	*
_product[created]	DateTime	*
_product[updated]	DateTime	*
_product[_variants][]	array of objects (Variant)	*
_product[_variants][][id]	integer	*
_product[_variants][][title]	string	*
_product[_variants][][inventory_quantity]	integer	*
_product[_variants][][barcode]	string	*
_product[_variants][][sku]	string	*
_product[_variants][][features]	string	*
_product[_variants][][created]	DateTime	*
_product[_variants][][updated]	DateTime	*
_product[_variants][][_price]	object (VariantPrice)	*
_product[_variants][][_product]	object (Product)	*
_product[_product_status]	object (ProductStatus)	*
_product[_product_status][name]	string	*
_product[_product_status][slug]	string	*
_product[_product_status][description]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /accounts/{account_slug}/products/{product_slug}/variants/{variant_id}

Update a variant

Documentation
Sandbox

Documentation

Update partial elements of a variant. Use this method when you do not need to update all the elements at the same time.

Allowed parameters to be updated are: title, inventory_quantity, barcode, sku, features, prices

Request Format

 {
     "title": "Iphone 8 x230-ds",
     "inventory_quantity":800,
     "barcode":"839384029",
     "sku":"839384029",
     "features":"The features",
     "price": {
         "currency_code":"USD",
         "amount":"99.99"
     }
 }

Requirements

Name	Requirement	Type	Description
variant_id	\d+	integer	the variant id
account_slug		string	the client account slug
product_slug		string	the product slug

Status Codes

Status Code	Description
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /accounts/{account_slug}/products/{product_slug}/variants/{variant_id}

Update a variant

Documentation
Sandbox

Documentation

Update a variant.

Request Format

Not all parameters in the content of the request are mandatory.Parameter features is optional.

 {
     "variant": {
         "title": "Iphone 8 x230-ds",
         "inventory_quantity":800,
         "barcode":"839384029",
         "sku":"839384029",
         "features":"The features",
         "price": {
             "currency_code":"USD",
             "amount":"99.99"
         }
     }
 }

Requirements

Name	Requirement	Type	Description
variant_id	\d+	integer	the variant id
account_slug		string	the client account slug
product_slug		string	the product slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/products/{product_slug}/variants/{variant_id}/prices/{currency_code}

PATCH /accounts/{account_slug}/products/{product_slug}/variants/{variant_id}/prices/{currency_code}

Update a variant's price

Documentation
Sandbox

Documentation

Update the price amount.

Allowed parameter to be updated is: amount.

Request Format

 {
     "amount":"99.00"
 }

Requirements

Name	Requirement	Type	Description
variant_id	\d+	integer	the variant id
account_slug		string	the client account slug
product_slug		string	the product slug
currency_code		string	the currency code

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Redemption Requests

/accounts/{account_slug}/redemption-requests

GET /accounts/{account_slug}/redemption-requests

Get redemption requests

Documentation
Sandbox

Documentation

Get the list of redemption requests.

Response Format

{
    "code": 200,
    "data": {
        "limit": 1,
        "page": 1,
        "results": [
            {
                "_advocate": {
                    "_bonuses_redemption_method": {
                        "description": "Automatically redeem the bonuses as credit",
                        "name": "Auto into credit",
                        "slug": "auto-into-credit"
                    },
                    "_currency": {
                        "code": "USD",
                        "currency": "United States Dollar",
                        "suffix": "¢",
                        "unicode": "32",
                        "updated": "2014-02-06T19:01:10+0000"
                    },
                    "claimed_balance": 0,
                    "created": "2014-02-06T19:01:10+0000",
                    "email": "alain_at_mail.com",
                    "lastname": "Hernandez",
                    "name": "Alain",
                    "payout_threshold": 10,
                    "token": "37e72fde36cf73a7f42fea1640dfe3d43f2add7e",
                    "total_bonuses": 0,
                    "total_referrals": 1,
                    "unclaimed_balance": 10
                },
                "amount": 1,
                "created": "2014-02-06T19:01:12+0000",
                "currency_code": "USD",
                "description": "Credit",
                "internal_note": "the note",
                "id": 1,
                "request_action_slug": "credit",
                "request_status_slug": "requested",
                "status_date": "2022-10-25T12:16:50+00:00",
                "updated": "2014-02-06T19:01:12+0000",
                "setting": {
                    "statusLogs": [
                        {
                            "status": "requested",
                            "date": "2022-10-25 12:15:45",
                            "modified_by": "John Doe"
                        },
                        {
                            "status": "processing",
                            "date": "2022-10-25 12:16:50",
                            "modified_by": "John Doe"
                        }
                    ]
                }
            }
        ],
        "total": 11
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: redemption_request_id, name, lastname, email, request_status_slug, request_action_slug, from, to, created, amount, amount_from, amount_to. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: ame, lastname, email, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions	Description
200 - Returned when successful

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/redemption-requests

Create a redemption request

Documentation
Sandbox

Documentation

Create a redemption request.

Request Format

Mandatory parameters: advocate_token, request_status_slug, request_action_slug, currency_code, amount.

 {
    "redemption_request":
        {
            "advocate_token":"k3ibasd723278v2b32389589ihjf",
            "request_status_slug":"requested",
            "request_action_slug": "credit",
            "currency_code":"USD",
            "amount":50,
            "description": "credit",
            "advocates_paypal_username":"alain_at_mail.com",
            "internal_note": "the note",
            "modified_by": "John Doe"
        }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/redemption-requests/{redemption_request_id}

GET /accounts/{account_slug}/redemption-requests/{redemption_request_id}

Get a redemption request

Documentation
Sandbox

Documentation

Get a redemption request by a given id.

Response Format

{
    "code": 200,
    "data": {
        "_advocate": {
            "_bonuses_redemption_method": {
                "description": "Automatically redeem the bonuses as credit",
                "name": "Auto into credit",
                "slug": "auto-into-credit"
            },
            "_currency": {
                "code": "USD",
                "currency": "United States Dollar",
                "suffix": "¢",
                "unicode": "32",
                "updated": "2014-02-06T19:01:10+0000"
            },
            "claimed_balance": 0,
            "created": "2014-02-06T19:01:10+0000",
            "email": "alain_at_mail.com",
            "lastname": "Hernandez",
            "name": "Alain",
            "payout_threshold": 10,
            "token": "37e72fde36cf73a7f42fea1640dfe3d43f2add7e",
            "total_bonuses": 0,
            "total_referrals": 1,
            "unclaimed_balance": 10
        },
        "amount": 1,
        "created": "2014-02-06T19:01:12+0000",
        "currency_code": "USD",
        "description": "Credit",
        "internal_note": "the note",
        "id": 1,
        "request_action_slug": "credit",
        "request_status_slug": "requested",
        "status_date": "2022-10-25T12:16:50+00:00",
        "updated": "2014-02-06T19:01:12+0000",
        "setting": {
            "statusLogs": [
                {
                    "status": "requested",
                    "date": "2022-10-25 12:15:45",
                    "modified_by": "John Doe"
                },
                {
                    "status": "processing",
                    "date": "2022-10-25 12:16:50",
                    "modified_by": "John Doe"
                }
            ]
        }
    }
}

Requirements

Name	Requirement	Type	Description
redemption_request_id	\d+	string	the redemption request id
account_slug		string	the client account slug

Return

Parameter	Type	Versions	Description
200 - Returned when successful

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/redemption-requests/{redemption_request_id}/redemption

PATCH /accounts/{account_slug}/redemption-requests/{redemption_request_id}/redemption

Redeem a redemption request

Documentation
Sandbox

Documentation

Redeem a redemption request. After the redemption request is created it needs to be redeemed. This will deduct the amount of the advocate unclaimed balance and move the request to the completed state.

Request Format

There is not mandatory parameters.

  {
       "modified_by": "John Doe
  }

Requirements

Name	Requirement	Type	Description
redemption_request_id	\d+	string	the redemption request id
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/redemption-request-actions

GET /utilities/redemption-request-actions

Get redemption request actions

Documentation
Sandbox

Documentation

Get redemption request actions.

Response Format

{
    "code": 200,
    "data": [
        {
            "description": "Receive bonus as cash",
            "name": "Paypal",
            "slug": "paypal"
        },
        {
            "description": "Receive bonus as credit",
            "name": "Credit",
            "slug": "credit"
        }
    ]
}

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/redemption-request-actions/{redemption_request_action_slug}

GET /utilities/redemption-request-actions/{redemption_request_action_slug}

Get a redemption request action

Documentation
Sandbox

Documentation

Get a redemption request action.

Response Format

{
    "code": 200,
    "data": {
        "description": "Receive bonus as call credit",
        "name": "Credit",
        "slug": "credit"
    }
}

Requirements

Name	Requirement	Type	Description
redemption_request_action_slug		string	the redemption request action slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/redemption-request-statuses

GET /utilities/redemption-request-statuses

Get redemption request statuses

Documentation
Sandbox

Documentation

Get redemption request statuses.

Response Format

{
    "code": 200,
    "data": [
        {
            "description": "Advocate has requested an exchange",
            "name": "Requested",
            "slug": "requested"
        },
        {
            "description": "The request has been declined by admin team",
            "name": "Declined",
            "slug": "declined"
        },
        {
            "description": "The request has being processed",
            "name": "Processing",
            "slug": "processing"
        },
        {
            "description": "The request has been completed",
            "name": "Completed",
            "slug": "completed"
        },
        {
            "description": "The request is in hold",
            "name": "Hold",
            "slug": "hold"
        }
    ]
}

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/redemption-request-statuses/{redemption_request_status_slug}

GET /utilities/redemption-request-statuses/{redemption_request_status_slug}

Get a redemption request status

Documentation
Sandbox

Documentation

Get a redemption request status.

Response Format

{
    "code": 200,
    "data": {
        "description": "The request has been completed",
        "name": "Completed",
        "slug": "completed"
    }
}

Requirements

Name	Requirement	Type	Description
redemption_request_status_slug		string	the redemption request status slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Referrals

/accounts/{account_slug}/advocates/{advocate_token}/referrals

GET /accounts/{account_slug}/advocates/{advocate_token}/referrals

Get referrals

Documentation
Sandbox

Documentation

Get the list of referrals for a given advocate.

Response Format

  {
    "code": 200,
    "data": {
        "limit": 1,
        "page": 1,
        "results": [
            {
                "_advocate": {
                    "_bonuses_redemption_method": {
                        "description": "Automatically redeem the bonuses as credit",
                        "name": "Auto into credit",
                        "slug": "auto-into-credit"
                    },
                    "_currency": {
                        "code": "USD",
                        "currency": "United States Dollar",
                        "suffix": "¢",
                        "unicode": "32"
                    },
                    "claimed_balance": 0,
                    "created": "2014-01-08T05:05:53+0000",
                    "email": "advocate3_at_email.com",
                    "lastname": "Chagas",
                    "name": "Advocate3",
                    "payout_threshold": 10,
                    "token": "9e77486b2b72a8d2aa5721dcc9574bec7c62da21",
                    "unclaimed_balance": 0,
                    "status": "active",
                    "setting": {
                        "statusLogs": "[{\"status\":\"active\",\"date\":\"2019-05-15 03:51:42\"}]"
                    }
                },
                "_referral_origin": {
                    "description": "Facebook website like button",
                    "name": "Facebook Like",
                    "slug": "facebook-like"
                },
                "_referred_advocate": {
                    "_advocate_referrer": {
                        "_bonuses_redemption_method": {
                            "description": "Automatically redeem the bonuses as credit",
                            "name": "Auto into credit",
                            "slug": "auto-into-credit"
                        },
                        "_currency": {
                            "code": "USD",
                            "currency": "United States Dollar",
                            "suffix": "¢",
                            "unicode": "32"
                        },
                        "claimed_balance": 0,
                        "created": "2014-01-08T05:05:53+0000",
                        "email": "advocate3_at_email.com",
                        "lastname": "Chagas",
                        "name": "Advocate3",
                        "payout_threshold": 10,
                        "token": "9e77486b2b72a8d2aa5721dcc9574bec7c62da21",
                        "unclaimed_balance": 0,
                        "status": "active",
                        "setting": {
                            "statusLogs": "[{\"status\":\"active\",\"date\":\"2019-05-15 03:51:42\"}]"
                        }
                    },
                    "_bonuses_redemption_method": {
                        "description": "Automatically redeem the bonuses as credit",
                        "name": "Auto into credit",
                        "slug": "auto-into-credit"
                    },
                    "_currency": {
                        "code": "USD",
                        "currency": "United States Dollar",
                        "suffix": "¢",
                        "unicode": "32"
                    },
                    "claimed_balance": 0,
                    "created": "2014-01-08T05:05:53+0000",
                    "email": "advocate4_at_email.com",
                    "lastname": "Chagas",
                    "name": "Advocate4",
                    "payout_threshold": 10,
                    "token": "148e04352d65747fc93427805c9e1be9ee4d8a78",
                    "unclaimed_balance": 0,
                    "status": "pending",
                    "setting": {
                        "statusLogs": "[{\"status\":\"pending\",\"date\":\"2019-05-16 03:51:42\"}]"
                    }
                },
                "created": "2014-01-08T05:05:53+0000",
                "id": 20,
                "url": "http://www.example.com"
            }
        ],
        "total": 3
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		integer	the advocate token

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: referred_advocate_token, url, referral_origin_slug, created, status, fullname, name, lastname, email, from, to, fraudulent. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
url	string	*
created	DateTime	*
updated	DateTime	*
_advocate	object (Advocate)	*
_advocate[email]	string	*
_advocate[lastname]	string	*
_advocate[name]	string	*
_advocate[token]	string	*
_advocate[short_token]	string	*
_advocate[code]	string	*
_advocate[payout_threshold]	float	*
_advocate[claimed_balance]	float	*
_advocate[unclaimed_balance]	float	*
_advocate[total_referrals]	integer	*
_advocate[total_bonuses]	integer	*
_advocate[created]	DateTime	*
_advocate[updated]	DateTime	*
_advocate[total_clicks]	integer	*
_advocate[total_shares]	integer	*
_advocate[avatar_url]	string	*
_advocate[metadata]	string	*
_advocate[can_refer]	boolean	*
_advocate[status]	string	*
_advocate[status_date]	DateTime	*
_advocate[setting]	array	*
_advocate[is_email_confirmed]	boolean	*
_advocate[fraudulent]	boolean	*
_advocate[_advocate_referrer]	object (Advocate)	*
_advocate[_currency]	object (Currency)	*
_advocate[_currency][code]	string	*
_advocate[_currency][unicode]	string	*
_advocate[_currency][currency]	string	*
_advocate[_currency][suffix]	string	*
_advocate[_currency][updated]	DateTime	*
_advocate[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate[_bonuses_redemption_method][name]	string	*
_advocate[_bonuses_redemption_method][description]	string	*
_advocate[_bonuses_redemption_method][slug]	string	*
_advocate[_campaign_contract]	object (Campaign)	*
_advocate[_campaign_contract][name]	string	*
_advocate[_campaign_contract][description]	string	*
_advocate[_campaign_contract][start_date]	DateTime	*
_advocate[_campaign_contract][end_date]	DateTime	*
_advocate[_campaign_contract][is_active]	boolean	*
_advocate[_campaign_contract][schemaless_config]	string	*
_advocate[_campaign_contract][created]	DateTime	*
_advocate[_campaign_contract][updated]	DateTime	*
_advocate[_campaign_contract][slug]	string	*
_advocate[_campaign_contract][total_advocates]	integer	*
_advocate[_campaign_contract][startDate]	DateTime	*
_advocate[_campaign_contract][endDate]	DateTime	*
_advocate[_campaign_contract][isActive]	bool	*
_advocate[_campaign_contract][schemalessConfig]		*
_advocate[_campaign]	object (Campaign)	*
_referred_advocate	object (Advocate)	*
_referral_origin	object (ReferralOrigin)	*
_referral_origin[name]	string	*
_referral_origin[description]	string	*
_referral_origin[slug]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/advocates/{advocate_token}/referrals

Create a Genius Referral referral

Documentation
Sandbox

Documentation

Create a new referral. A referral is a link between an Advocate and a Referral (another advocate).

Request Format

Not all parameters in the content of the request are mandatory.Parameter status is optional.

{
    "referral":{
        "referred_advocate_token":"10e33ae1b516873a8fe62880652759d558e27424",
        "referral_origin_slug": "facebook-share",
        "campaign_slug":"get-10-of-for-90-days",
        "http_referer":"http://www.google.com",
        "status": "active"
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
advocate_token		integer	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}/referrals/{referral_id}

DELETE /accounts/{account_slug}/advocates/{advocate_token}/referrals/{referral_id}

Delete a referral

Documentation
Sandbox

Documentation

Delete a referral

Requirements

Name	Requirement	Type	Description
referral_id	\d+	string	the advocate token
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/advocates/{advocate_token}/referrals/{referral_id}

Get a referral

Documentation
Sandbox

Documentation

Get a referral by a given id.

Response Format

{
    "code": 200,
    "data": {
        "_advocate": {
            "_bonuses_redemption_method": {
                "description": "Automatically redeem the bonuses as credit",
                "name": "Auto into credit",
                "slug": "auto-into-credit"
            },
            "_currency": {
                "code": "USD",
                "currency": "United States Dollar",
                "suffix": "¢",
                "unicode": "32"
            },
            "claimed_balance": 0,
            "created": "2014-01-09T20:07:47+0000",
            "email": "advocate_at_mail.com",
            "lastname": "Hernandez",
            "name": "advocate",
            "payout_threshold": 10,
            "token": "717a4bc85a74dc52f06cadb2fe7940b5486a14c9",
            "unclaimed_balance": 0
        },
        "_referral_origin": {
            "description": "Facebook website like button",
            "name": "Facebook Like",
            "slug": "facebook-like"
        },
        "_referred_advocate": {
            "_advocate_referrer": {
                "_bonuses_redemption_method": {
                    "description": "Automatically redeem the bonuses as credit",
                    "name": "Auto into credit",
                    "slug": "auto-into-credit"
                },
                "_currency": {
                    "code": "USD",
                    "currency": "United States Dollar",
                    "suffix": "¢",
                    "unicode": "32"
                },
                "claimed_balance": 0,
                "created": "2014-01-09T20:07:47+0000",
                "email": "advocate_at_email.com",
                "lastname": "Hernandez",
                "name": "Advocate",
                "payout_threshold": 10,
                "token": "717a4bc85a74dc52f06cadb2fe7940b5486a14c9",
                "unclaimed_balance": 0
            },
            "_bonuses_redemption_method": {
                "description": "Automatically redeem the bonuses as credit",
                "name": "Auto into credit",
                "slug": "auto-into-credit"
            },
            "_currency": {
                "code": "USD",
                "currency": "United States Dollar",
                "suffix": "¢",
                "unicode": "32"
            },
            "claimed_balance": 0,
            "created": "2014-01-09T20:07:47+0000",
            "email": "erica_at_email.com",
            "lastname": "Chagas",
            "name": "Erica",
            "payout_threshold": 10,
            "token": "f17b17295bd12d059b62e88ef1bcddac92c10b4a",
            "unclaimed_balance": 0
        },
        "created": "2014-01-09T20:07:47+0000",
        "id": 1,
        "url": "http://www.example.com"
    }
}

Requirements

Name	Requirement	Type	Description
referral_id	\d+	string	the advocate token
account_slug		string	the client account slug
advocate_token		string	the advocate token

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
url	string	*
created	DateTime	*
updated	DateTime	*
_advocate	object (Advocate)	*
_advocate[email]	string	*
_advocate[lastname]	string	*
_advocate[name]	string	*
_advocate[token]	string	*
_advocate[short_token]	string	*
_advocate[code]	string	*
_advocate[payout_threshold]	float	*
_advocate[claimed_balance]	float	*
_advocate[unclaimed_balance]	float	*
_advocate[total_referrals]	integer	*
_advocate[total_bonuses]	integer	*
_advocate[created]	DateTime	*
_advocate[updated]	DateTime	*
_advocate[total_clicks]	integer	*
_advocate[total_shares]	integer	*
_advocate[avatar_url]	string	*
_advocate[metadata]	string	*
_advocate[can_refer]	boolean	*
_advocate[status]	string	*
_advocate[status_date]	DateTime	*
_advocate[setting]	array	*
_advocate[is_email_confirmed]	boolean	*
_advocate[fraudulent]	boolean	*
_advocate[_advocate_referrer]	object (Advocate)	*
_advocate[_currency]	object (Currency)	*
_advocate[_currency][code]	string	*
_advocate[_currency][unicode]	string	*
_advocate[_currency][currency]	string	*
_advocate[_currency][suffix]	string	*
_advocate[_currency][updated]	DateTime	*
_advocate[_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_advocate[_bonuses_redemption_method][name]	string	*
_advocate[_bonuses_redemption_method][description]	string	*
_advocate[_bonuses_redemption_method][slug]	string	*
_advocate[_campaign_contract]	object (Campaign)	*
_advocate[_campaign_contract][name]	string	*
_advocate[_campaign_contract][description]	string	*
_advocate[_campaign_contract][start_date]	DateTime	*
_advocate[_campaign_contract][end_date]	DateTime	*
_advocate[_campaign_contract][is_active]	boolean	*
_advocate[_campaign_contract][schemaless_config]	string	*
_advocate[_campaign_contract][created]	DateTime	*
_advocate[_campaign_contract][updated]	DateTime	*
_advocate[_campaign_contract][slug]	string	*
_advocate[_campaign_contract][total_advocates]	integer	*
_advocate[_campaign_contract][startDate]	DateTime	*
_advocate[_campaign_contract][endDate]	DateTime	*
_advocate[_campaign_contract][isActive]	bool	*
_advocate[_campaign_contract][schemalessConfig]		*
_advocate[_campaign]	object (Campaign)	*
_referred_advocate	object (Advocate)	*
_referral_origin	object (ReferralOrigin)	*
_referral_origin[name]	string	*
_referral_origin[description]	string	*
_referral_origin[slug]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /accounts/{account_slug}/advocates/{advocate_token}/referrals/{referral_id}

Update a Genius Referral advocate

Documentation
Sandbox

Documentation

Update a referral.

Request Format

Not all parameters in the content of the request are mandatory.Parameter status is optional.

{
    "referral":{
        "referred_advocate_token":"10e33ae1b516873a8fe62880652759d558e27424",
        "referral_origin_slug": "facebook-share",
        "campaign_slug":"get-10-of-for-90-days",
        "http_referer":"http://www.google.com",
        "status": "active"
    }
}

Requirements

Name	Requirement	Type	Description
referral_id	\d+	integer	the referral id
account_slug		string	the client account slug
advocate_token		string	the advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/referral-origins

GET /utilities/referral-origins

Return referral origins

Documentation
Sandbox

Documentation

Get referral origins. This is needed when creating (POST) a new referral as referral_origin_slug refers to one of this origins.

Response Format

  {
    "code": 200,
    "data": [
        {
            "description": "Facebook website share",
            "name": "Facebook Share",
            "slug": "facebook-share"
        },
        {
            "description": "Twitter website post",
            "name": "Twitter Post",
            "slug": "twitter-post"
        },
        {
            "description": "Linkedin website post",
            "name": "Linkedin Post",
            "slug": "linkedin-post"
        }
        {
            "description": "Pinterest website like button",
            "name": "Pin It",
            "slug": "pin-it"
        },
        {
            "description": "Google +1 website like button",
            "name": "Google +1",
            "slug": "google-1"
        },
        {
            "description": "Instagram website Comment",
            "name": "Instagram Comment",
            "slug": "instagram-comment"
        },
        {
            "description": "Email sent to the user by our systems",
            "name": "Direct Email",
            "slug": "direct-email"
        },
        {
            "description": "Personal recomendacion throw our systems",
            "name": "Personal",
            "slug": "personal"
        },
        {
            "description": "The user has changed the origin",
            "name": "Other",
            "slug": "other"
        }
    ]
}

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/utilities/referral-origins/{referral_origin_slug}

GET /utilities/referral-origins/{referral_origin_slug}

Return a referral origin

Documentation
Sandbox

Documentation

Get a referral origin by a given slug.

Response Format

  {
      "code": 200,
      "data": {
          "description": "Personal recomendacion throw our systems",
          "name": "Personal",
          "slug": "personal"
      }
  }

Requirements

Name	Requirement	Type	Description
referral_origin_slug		string	the referral origin slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
description	string	*
slug	string	*

Status Codes

Status Code	Description
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Reports

/reports/1099-tax-report

GET /reports/1099-tax-report

Get 1099 Tax report

Documentation
Sandbox

Documentation

Get 1099 Tax report.

Response Format

{ "code": 200, "data": [ { "name": "Jon", "lastname": "Smith", "email": "Jon@gmail.com", "token": "f46c439d82b9cf63e8537ec75e651f12a602a306", "amount": "6.000000000", "payment_method": "bank_transfer" }, { "name": "Jon", "lastname": "Smith", "email": "Jon@gmail.com", "token": "f46c439d82b9cf63e8537ec75e651f12a602a306", "amount": "10.000000000", "payment_method": "paypal" } ] }

Filters

Name

Information

client_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

advocate_token

Description

The advocate token

year

Description

The datetime were the range of the search starts

annual_payment_limit

Requirement
Description	The annual payment limit
Default	600

Status Codes

Status Code	Description
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/bonuses-daily-given

GET /reports/bonuses-daily-given

Return bonuses daily given

Documentation
Sandbox

Documentation

Get bonuses daily given.

Response Format

{
  "code": 200,
  "data": [
    {
      "id": 729,
      "facebook_like": 15,
      "facebook_share": 51,
      "twitter_post": 71,
      "twitter_follow": 0,
      "linkedin_post": 10,
      "linkedin_follow": 29,
      "pin_it": 56,
      "google_plus": 45,
      "instagram_like": 3,
      "instagram_comment": 51,
      "personal_url": 64,
      "direct_email": 80,
      "other": 12,
      "date": "2013-12-29T00:00:00+0000",
      "created": "2013-12-31T21:39:21+0000"
    }
  ]
}

Filters

Name

Information

account_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

advocate_token

Description

The advocate token

from

Description

The datetime were the range of the search starts

Description

The datetime were the range of the search stops

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/bonuses-summary-per-origin

GET /reports/bonuses-summary-per-origin

Get bonuses symmary

Documentation
Sandbox

Documentation

Get bonuses summary per referral origin.

Response Format

 {
    "code": 200,
    "data": [
        {
            "amount": 2.50,
            "name": "Facebook Share",
            "slug": "facebook-share"
        },
        {
            "amount": 5,
            "name": "Twitter Post",
            "slug": "twitter-post"
        },
        {
            "amount": 2.50,
            "name": "Linkedin Post",
            "slug": "linkedin-post"
        }
    ]
}

Filters

Name

Information

advocate_token

Description

The advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/click-daily-participation

GET /reports/click-daily-participation

Get click daily participation

Documentation
Sandbox

Documentation

Get click daily participation.

Response Format

{
  "code": 200,
  "data": [
    {
      "id": 729,
      "facebook_like": 15,
      "facebook_share": 51,
      "twitter_post": 71,
      "twitter_follow": 0,
      "linkedin_post": 10,
      "linkedin_follow": 29,
      "pin_it": 56,
      "google_plus": 45,
      "instagram_like": 3,
      "instagram_comment": 51,
      "personal_url": 64,
      "direct_email": 80,
      "other": 12,
      "date": "2013-12-29T00:00:00+0000",
      "created": "2013-12-31T21:39:21+0000"
    }
  ]
}

Filters

Name

Information

account_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

advocate_token

Description

The advocate token

from

Description

The datetime were the range of the search starts

Description

The datetime were the range of the search stops

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/referral-daily-participation

GET /reports/referral-daily-participation

Get referral daily participation

Documentation
Sandbox

Documentation

Get referral daily participation.

Response Format

{
  "code": 200,
  "data": [
    {
      "id": 729,
      "facebook_like": 15,
      "facebook_share": 51,
      "twitter_post": 71,
      "twitter_follow": 0,
      "linkedin_post": 10,
      "linkedin_follow": 29,
      "pin_it": 56,
      "google_plus": 45,
      "instagram_like": 3,
      "instagram_comment": 51,
      "personal_url": 64,
      "direct_email": 80,
      "other": 12,
      "date": "2013-12-29T00:00:00+0000",
      "created": "2013-12-31T21:39:21+0000"
    }
  ]
}

Filters

Name

Information

account_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

advocate_token

Description

The advocate token

from

Description

The datetime were the range of the search starts

Description

The datetime were the range of the search stops

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/referrals-summary-per-origin

GET /reports/referrals-summary-per-origin

Get referrals symmary

Documentation
Sandbox

Documentation

Get referrals summary per referral origin.

Response Format

 {
    "code": 200,
    "data": [
        {
            "amount": 1,
            "name": "Facebook Share",
            "slug": "facebook-share"
        },
        {
            "amount": 1,
            "name": "Twitter Post",
            "slug": "twitter-post"
        },
        {
            "amount": 1,
            "name": "Linkedin Post",
            "slug": "linkedin-post"
        }
    ]
}

Filters

Name

Information

advocate_token

Description

The advocate token

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/revenue

GET /reports/revenue

Return revenue summary

Documentation
Sandbox

Documentation

Get revenue summary.

Response Format

  {
      "code": 200,
      "data": {
          "page": 1,
          "limit": 10,
          "total": 1,
          "results": [
              {
                  "revenue": 3,
                  "date": "2022-02-01T20:47:35+0000",
                  "campaign_name": "Get 10% of for 90 days",
                  "campaign_slug": "get-10-of-for-90-days-1",
              }
          ]
      }
  }

Filters

Name

Information

client_account_slug

Description

The client account slug

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

from

Description

The datetime were the range of the search starts

Description

The datetime were the range of the search stops

campaign_slug

Description

The campaign slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/share-daily-participation

GET /reports/share-daily-participation

Get share daily participation

Documentation
Sandbox

Documentation

Get share daily participation.

Response Format

{
  "code": 200,
  "data": [
    {
      "id": 729,
      "facebook_like": 15,
      "facebook_share": 51,
      "twitter_post": 71,
      "twitter_follow": 0,
      "linkedin_post": 10,
      "linkedin_follow": 29,
      "pin_it": 56,
      "google_plus": 45,
      "instagram_like": 3,
      "instagram_comment": 51,
      "personal_url": 64,
      "direct_email": 80,
      "other": 12,
      "date": "2013-12-29T00:00:00+0000",
      "created": "2013-12-31T21:39:21+0000"
    }
  ]
}

Filters

Name

Information

account_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

advocate_token

Description

The advocate token

from

Description

The datetime were the range of the search starts

Description

The datetime were the range of the search stops

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/reports/top-advocates

GET /reports/top-advocates

Return top 10 advocates

Documentation
Sandbox

Documentation

Get top 10 advocates.

Response Format

 {
    "code": 200,
    "data": [
        {
            "amount_referrals": 3,
            "code": "USD",
            "email": "advocate3_at_email.com",
            "lastname": "Chagas",
            "name": "Advocate3",
            "total_bonuses": 10,
            "total_clicks": 5,
            "total_shares": 3
        }
    ]
}

Filters

Name

Information

account_slug

Description

The client account slug

campaign_slug

Description

The campaign slug

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

from

Description

The datetime were the range of the search starts

Description

The datetime were the range of the search stops

sort

Requirement	.+
Description	Allowed fields: amount_referrals, total_bonuses, total_clicks, total_shares. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('\|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name\|first_name\|-hire_date'
Default	-amount_referrals

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Roots
- /
  - - GET /
      
      Root resource
      Documentation
      
      Sandbox
      
      Documentation
      
      Welcome to Genius Referral Core API
      
      Response Format
      
      { "links": { "accounts": { "href": "http://api.geniusreferrals.com/accounts" }, "bonuses_redemption_methods": { "href": "http://api.geniusreferrals.com/utilities/bonuses-redemption-methods" }, "bonuses_summary_per_origin": { "href": "http://api.geniusreferrals.com/reports/bonuses-summary-per-origin" }, "currencies": { "href": "http://api.geniusreferrals.com/utilities/currencies" }, "redemption_request_actions": { "href": "http://api.geniusreferrals.com/utilities/redemption-request-actions" }, "redemption_request_statuses": { "href": "http://api.geniusreferrals.com/utilities/redemption-request-statuses" }, "referral_origins": { "href": "http://api.geniusreferrals.com/utilities/referral-origins" }, "referrals_summary_per_origin": { "href": "http://api.geniusreferrals.com/reports/referrals-summary-per-origin" }, "self": { "href": "http://api.geniusreferrals.com/" }, "test_authentication": { "href": "http://api.geniusreferrals.com/test-authentication" } } }
      
      Input
      
      Headers
      = -
      
      Content
      = Replaces header if set
      
      Request URL
      
      Request body
      
      Response Headers [Expand] [Profiler]
      
      Response Body [Raw]
      
      Curl Command Line

Show/hide List Operations Expand Operations

Vouchers

/accounts/{account_slug}/vouchers

GET /accounts/{account_slug}/vouchers

Get vouchers

Documentation
Sandbox

Documentation

Get the list of vouchers for a given program.

Response Format

{
    "code": 200,
    "data": {
        "page": 1,
        "limit": 10,
        "total": 1,
        "results": [
            {
                "id": 1,
                "code": "XXX-555-XXX",
                "value": 99.99,
                "_currency": {
                    "code": "USD",
                    "unicode": "32",
                    "currency": "United States Dollar",
                    "suffix": "¢",
                    "updated": "2019-08-19T22:00:55+0000"
                },
                "setting": {
                    "statusLogs": "[{"status":"available","statusId":1,"date":"2020-05-12 19:29:56"}]"
                },
                "created": "2020-05-12T19:29:56+0000",
                "updated": "2020-05-12T19:29:56+0000",
               "_status": {
                   "name": "Available",
                   "slug": "available",
                   "description": "Status when the voucher is ready to be redeemed"
               },
           }
        ]
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: code, value, status, currency_code, created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: value, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
code	string	*
value	float	*
setting	array	*
created	DateTime	*
updated	DateTime	*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_status	object (VoucherStatus)	*
_status[name]	string	*
_status[slug]	string	*
_status[description]	string	*
_exchange_bonus_request	object (ExchangeBonusRequest)	*
_exchange_bonus_request[id]	integer	*
_exchange_bonus_request[amount]	float	*
_exchange_bonus_request[description]	string	*
_exchange_bonus_request[schemaless_config]	string	*
_exchange_bonus_request[setting]	array	*
_exchange_bonus_request[internal_note]	string	*
_exchange_bonus_request[created]	DateTime	*
_exchange_bonus_request[updated]	DateTime	*
_exchange_bonus_request[_bonuses][]	array of objects (Bonus)	*
_exchange_bonus_request[_bonuses][][id]	integer	*
_exchange_bonus_request[_bonuses][][amount]	float	*
_exchange_bonus_request[_bonuses][][created]	DateTime	*
_exchange_bonus_request[_bonuses][][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_currency]	object (Currency)	*
_exchange_bonus_request[_bonuses][][_advocate]	object (Advocate)	*
_exchange_bonus_request[_bonuses][][_advocate][email]	string	*
_exchange_bonus_request[_bonuses][][_advocate][lastname]	string	*
_exchange_bonus_request[_bonuses][][_advocate][name]	string	*
_exchange_bonus_request[_bonuses][][_advocate][token]	string	*
_exchange_bonus_request[_bonuses][][_advocate][short_token]	string	*
_exchange_bonus_request[_bonuses][][_advocate][code]	string	*
_exchange_bonus_request[_bonuses][][_advocate][payout_threshold]	float	*
_exchange_bonus_request[_bonuses][][_advocate][claimed_balance]	float	*
_exchange_bonus_request[_bonuses][][_advocate][unclaimed_balance]	float	*
_exchange_bonus_request[_bonuses][][_advocate][total_referrals]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][total_bonuses]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][total_clicks]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][total_shares]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][avatar_url]	string	*
_exchange_bonus_request[_bonuses][][_advocate][metadata]	string	*
_exchange_bonus_request[_bonuses][][_advocate][can_refer]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][status]	string	*
_exchange_bonus_request[_bonuses][][_advocate][status_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][setting]	array	*
_exchange_bonus_request[_bonuses][][_advocate][is_email_confirmed]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][fraudulent]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][_advocate_referrer]	object (Advocate)	*
_exchange_bonus_request[_bonuses][][_advocate][_currency]	object (Currency)	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method][name]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method][description]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method][slug]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract]	object (Campaign)	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][name]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][description]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][start_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][end_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][is_active]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][schemaless_config]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][slug]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][total_advocates]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][startDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][endDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][isActive]	bool	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][schemalessConfig]		*
_exchange_bonus_request[_bonuses][][_advocate][_campaign]	object (Campaign)	*
_exchange_bonus_request[_bonuses][][_referred_advocate]	object (Advocate)	*
_exchange_bonus_request[_bonuses][][bonus_request_trace]	object (BonusRequestTrace)	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][id]	integer	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][trace]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][message]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][reference]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][created]	DateTime	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][advocate_referrer_token]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][advocate_token]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][campaign_slug]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][bonus_amount]	float	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][result]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][bonuses][]	array of objects (Bonus)	*
_exchange_bonus_request[_bonuses][][referred_advocate_token]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_full_name]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_email]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_currency_code]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_can_refer]	boolean	*
_exchange_bonus_request[_bonuses][][redemption_request_id]	integer	*
_exchange_bonus_request[_bonuses][][_bonus_type]	object (BonusType)	*
_exchange_bonus_request[_bonuses][][_bonus_type][name]	string	*
_exchange_bonus_request[_bonuses][][_bonus_type][description]	string	*
_exchange_bonus_request[_bonuses][][_bonus_type][slug]	string	*
_exchange_bonus_request[_bonuses][][reference]	string	*
_exchange_bonus_request[_bonuses][][payment_amount]	float	*
_exchange_bonus_request[_bonuses][][status]	string	*
_exchange_bonus_request[_bonuses][][status_date]	DateTime	*
_exchange_bonus_request[_bonuses][][setting]	array	*
_exchange_bonus_request[_bonuses][][_tags][]	array of objects (Tag)	*
_exchange_bonus_request[_bonuses][][_tags][][name]	string	*
_exchange_bonus_request[_bonuses][][_tags][][slug]	string	*
_exchange_bonus_request[_bonuses][][_tags][][description]	string	*
_exchange_bonus_request[_bonuses][][_tags][][color]	string	*
_exchange_bonus_request[_bonuses][][_tags][][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_tags][][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign]	object (Campaign)	*
_exchange_bonus_request[_bonuses][][_campaign][name]	string	*
_exchange_bonus_request[_bonuses][][_campaign][description]	string	*
_exchange_bonus_request[_bonuses][][_campaign][start_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][end_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][is_active]	boolean	*
_exchange_bonus_request[_bonuses][][_campaign][schemaless_config]	string	*
_exchange_bonus_request[_bonuses][][_campaign][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][slug]	string	*
_exchange_bonus_request[_bonuses][][_campaign][total_advocates]	integer	*
_exchange_bonus_request[_bonuses][][_campaign][startDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][endDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][isActive]	bool	*
_exchange_bonus_request[_bonuses][][_campaign][schemalessConfig]		*
_exchange_bonus_request[_advocate]	object (Advocate)	*
_exchange_bonus_request[_advocate][email]	string	*
_exchange_bonus_request[_advocate][lastname]	string	*
_exchange_bonus_request[_advocate][name]	string	*
_exchange_bonus_request[_advocate][token]	string	*
_exchange_bonus_request[_advocate][short_token]	string	*
_exchange_bonus_request[_advocate][code]	string	*
_exchange_bonus_request[_advocate][payout_threshold]	float	*
_exchange_bonus_request[_advocate][claimed_balance]	float	*
_exchange_bonus_request[_advocate][unclaimed_balance]	float	*
_exchange_bonus_request[_advocate][total_referrals]	integer	*
_exchange_bonus_request[_advocate][total_bonuses]	integer	*
_exchange_bonus_request[_advocate][created]	DateTime	*
_exchange_bonus_request[_advocate][updated]	DateTime	*
_exchange_bonus_request[_advocate][total_clicks]	integer	*
_exchange_bonus_request[_advocate][total_shares]	integer	*
_exchange_bonus_request[_advocate][avatar_url]	string	*
_exchange_bonus_request[_advocate][metadata]	string	*
_exchange_bonus_request[_advocate][can_refer]	boolean	*
_exchange_bonus_request[_advocate][status]	string	*
_exchange_bonus_request[_advocate][status_date]	DateTime	*
_exchange_bonus_request[_advocate][setting]	array	*
_exchange_bonus_request[_advocate][is_email_confirmed]	boolean	*
_exchange_bonus_request[_advocate][fraudulent]	boolean	*
_exchange_bonus_request[_advocate][_advocate_referrer]	object (Advocate)	*
_exchange_bonus_request[_advocate][_currency]	object (Currency)	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method][name]	string	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method][description]	string	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method][slug]	string	*
_exchange_bonus_request[_advocate][_campaign_contract]	object (Campaign)	*
_exchange_bonus_request[_advocate][_campaign_contract][name]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][description]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][start_date]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][end_date]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][is_active]	boolean	*
_exchange_bonus_request[_advocate][_campaign_contract][schemaless_config]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][created]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][updated]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][slug]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][total_advocates]	integer	*
_exchange_bonus_request[_advocate][_campaign_contract][startDate]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][endDate]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][isActive]	bool	*
_exchange_bonus_request[_advocate][_campaign_contract][schemalessConfig]		*
_exchange_bonus_request[_advocate][_campaign]	object (Campaign)	*
_exchange_bonus_request[request_action_slug]	string	*
_exchange_bonus_request[request_action_name]	string	*
_exchange_bonus_request[request_status_slug]	string	*
_exchange_bonus_request[request_status_name]	string	*
_exchange_bonus_request[status_date]	DateTime	*
_exchange_bonus_request[currency_code]	string	*
_exchange_bonus_request[advocates_paypal_username]	string	*
_exchange_bonus_request[_voucher]	object (Voucher)	*
_exchange_bonus_request[_voucher][id]	integer	*
_exchange_bonus_request[_voucher][code]	string	*
_exchange_bonus_request[_voucher][value]	float	*
_exchange_bonus_request[_voucher][setting]	array	*
_exchange_bonus_request[_voucher][created]	DateTime	*
_exchange_bonus_request[_voucher][updated]	DateTime	*
_exchange_bonus_request[_voucher][_currency]	object (Currency)	*
_exchange_bonus_request[_voucher][_status]	object (VoucherStatus)	*
_exchange_bonus_request[_voucher][_exchange_bonus_request]	object (ExchangeBonusRequest)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/vouchers

Create a voucher

Documentation
Sandbox

Documentation

Create a new voucher.

Request Format

All parameters in the content of the request are mandatory.

{
    "voucher": {
        "code": "XXX-555-XXX",
        "value": 99.99,
        "currency_code":"USD",
        "status": "available"
    }
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/vouchers-denominations/{currency_code}

GET /accounts/{account_slug}/vouchers-denominations/{currency_code}

Get denominations

Documentation
Sandbox

Documentation

Get the list of vouchers denominations for a given program and currency code.

Response Format

{
    "code": 200,
    "data": [
        {
            "value": 99.99,
            "currency": "USD"
        }
    ]
}

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
currency_code		string	the currency code

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
code	string	*
value	float	*
setting	array	*
created	DateTime	*
updated	DateTime	*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_status	object (VoucherStatus)	*
_status[name]	string	*
_status[slug]	string	*
_status[description]	string	*
_exchange_bonus_request	object (ExchangeBonusRequest)	*
_exchange_bonus_request[id]	integer	*
_exchange_bonus_request[amount]	float	*
_exchange_bonus_request[description]	string	*
_exchange_bonus_request[schemaless_config]	string	*
_exchange_bonus_request[setting]	array	*
_exchange_bonus_request[internal_note]	string	*
_exchange_bonus_request[created]	DateTime	*
_exchange_bonus_request[updated]	DateTime	*
_exchange_bonus_request[_bonuses][]	array of objects (Bonus)	*
_exchange_bonus_request[_bonuses][][id]	integer	*
_exchange_bonus_request[_bonuses][][amount]	float	*
_exchange_bonus_request[_bonuses][][created]	DateTime	*
_exchange_bonus_request[_bonuses][][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_currency]	object (Currency)	*
_exchange_bonus_request[_bonuses][][_advocate]	object (Advocate)	*
_exchange_bonus_request[_bonuses][][_advocate][email]	string	*
_exchange_bonus_request[_bonuses][][_advocate][lastname]	string	*
_exchange_bonus_request[_bonuses][][_advocate][name]	string	*
_exchange_bonus_request[_bonuses][][_advocate][token]	string	*
_exchange_bonus_request[_bonuses][][_advocate][short_token]	string	*
_exchange_bonus_request[_bonuses][][_advocate][code]	string	*
_exchange_bonus_request[_bonuses][][_advocate][payout_threshold]	float	*
_exchange_bonus_request[_bonuses][][_advocate][claimed_balance]	float	*
_exchange_bonus_request[_bonuses][][_advocate][unclaimed_balance]	float	*
_exchange_bonus_request[_bonuses][][_advocate][total_referrals]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][total_bonuses]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][total_clicks]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][total_shares]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][avatar_url]	string	*
_exchange_bonus_request[_bonuses][][_advocate][metadata]	string	*
_exchange_bonus_request[_bonuses][][_advocate][can_refer]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][status]	string	*
_exchange_bonus_request[_bonuses][][_advocate][status_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][setting]	array	*
_exchange_bonus_request[_bonuses][][_advocate][is_email_confirmed]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][fraudulent]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][_advocate_referrer]	object (Advocate)	*
_exchange_bonus_request[_bonuses][][_advocate][_currency]	object (Currency)	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method][name]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method][description]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method][slug]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract]	object (Campaign)	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][name]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][description]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][start_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][end_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][is_active]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][schemaless_config]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][slug]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][total_advocates]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][startDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][endDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][isActive]	bool	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][schemalessConfig]		*
_exchange_bonus_request[_bonuses][][_advocate][_campaign]	object (Campaign)	*
_exchange_bonus_request[_bonuses][][_referred_advocate]	object (Advocate)	*
_exchange_bonus_request[_bonuses][][bonus_request_trace]	object (BonusRequestTrace)	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][id]	integer	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][trace]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][message]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][reference]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][created]	DateTime	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][advocate_referrer_token]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][advocate_token]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][campaign_slug]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][bonus_amount]	float	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][result]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][bonuses][]	array of objects (Bonus)	*
_exchange_bonus_request[_bonuses][][referred_advocate_token]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_full_name]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_email]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_currency_code]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_can_refer]	boolean	*
_exchange_bonus_request[_bonuses][][redemption_request_id]	integer	*
_exchange_bonus_request[_bonuses][][_bonus_type]	object (BonusType)	*
_exchange_bonus_request[_bonuses][][_bonus_type][name]	string	*
_exchange_bonus_request[_bonuses][][_bonus_type][description]	string	*
_exchange_bonus_request[_bonuses][][_bonus_type][slug]	string	*
_exchange_bonus_request[_bonuses][][reference]	string	*
_exchange_bonus_request[_bonuses][][payment_amount]	float	*
_exchange_bonus_request[_bonuses][][status]	string	*
_exchange_bonus_request[_bonuses][][status_date]	DateTime	*
_exchange_bonus_request[_bonuses][][setting]	array	*
_exchange_bonus_request[_bonuses][][_tags][]	array of objects (Tag)	*
_exchange_bonus_request[_bonuses][][_tags][][name]	string	*
_exchange_bonus_request[_bonuses][][_tags][][slug]	string	*
_exchange_bonus_request[_bonuses][][_tags][][description]	string	*
_exchange_bonus_request[_bonuses][][_tags][][color]	string	*
_exchange_bonus_request[_bonuses][][_tags][][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_tags][][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign]	object (Campaign)	*
_exchange_bonus_request[_bonuses][][_campaign][name]	string	*
_exchange_bonus_request[_bonuses][][_campaign][description]	string	*
_exchange_bonus_request[_bonuses][][_campaign][start_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][end_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][is_active]	boolean	*
_exchange_bonus_request[_bonuses][][_campaign][schemaless_config]	string	*
_exchange_bonus_request[_bonuses][][_campaign][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][slug]	string	*
_exchange_bonus_request[_bonuses][][_campaign][total_advocates]	integer	*
_exchange_bonus_request[_bonuses][][_campaign][startDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][endDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][isActive]	bool	*
_exchange_bonus_request[_bonuses][][_campaign][schemalessConfig]		*
_exchange_bonus_request[_advocate]	object (Advocate)	*
_exchange_bonus_request[_advocate][email]	string	*
_exchange_bonus_request[_advocate][lastname]	string	*
_exchange_bonus_request[_advocate][name]	string	*
_exchange_bonus_request[_advocate][token]	string	*
_exchange_bonus_request[_advocate][short_token]	string	*
_exchange_bonus_request[_advocate][code]	string	*
_exchange_bonus_request[_advocate][payout_threshold]	float	*
_exchange_bonus_request[_advocate][claimed_balance]	float	*
_exchange_bonus_request[_advocate][unclaimed_balance]	float	*
_exchange_bonus_request[_advocate][total_referrals]	integer	*
_exchange_bonus_request[_advocate][total_bonuses]	integer	*
_exchange_bonus_request[_advocate][created]	DateTime	*
_exchange_bonus_request[_advocate][updated]	DateTime	*
_exchange_bonus_request[_advocate][total_clicks]	integer	*
_exchange_bonus_request[_advocate][total_shares]	integer	*
_exchange_bonus_request[_advocate][avatar_url]	string	*
_exchange_bonus_request[_advocate][metadata]	string	*
_exchange_bonus_request[_advocate][can_refer]	boolean	*
_exchange_bonus_request[_advocate][status]	string	*
_exchange_bonus_request[_advocate][status_date]	DateTime	*
_exchange_bonus_request[_advocate][setting]	array	*
_exchange_bonus_request[_advocate][is_email_confirmed]	boolean	*
_exchange_bonus_request[_advocate][fraudulent]	boolean	*
_exchange_bonus_request[_advocate][_advocate_referrer]	object (Advocate)	*
_exchange_bonus_request[_advocate][_currency]	object (Currency)	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method][name]	string	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method][description]	string	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method][slug]	string	*
_exchange_bonus_request[_advocate][_campaign_contract]	object (Campaign)	*
_exchange_bonus_request[_advocate][_campaign_contract][name]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][description]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][start_date]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][end_date]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][is_active]	boolean	*
_exchange_bonus_request[_advocate][_campaign_contract][schemaless_config]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][created]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][updated]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][slug]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][total_advocates]	integer	*
_exchange_bonus_request[_advocate][_campaign_contract][startDate]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][endDate]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][isActive]	bool	*
_exchange_bonus_request[_advocate][_campaign_contract][schemalessConfig]		*
_exchange_bonus_request[_advocate][_campaign]	object (Campaign)	*
_exchange_bonus_request[request_action_slug]	string	*
_exchange_bonus_request[request_action_name]	string	*
_exchange_bonus_request[request_status_slug]	string	*
_exchange_bonus_request[request_status_name]	string	*
_exchange_bonus_request[status_date]	DateTime	*
_exchange_bonus_request[currency_code]	string	*
_exchange_bonus_request[advocates_paypal_username]	string	*
_exchange_bonus_request[_voucher]	object (Voucher)	*
_exchange_bonus_request[_voucher][id]	integer	*
_exchange_bonus_request[_voucher][code]	string	*
_exchange_bonus_request[_voucher][value]	float	*
_exchange_bonus_request[_voucher][setting]	array	*
_exchange_bonus_request[_voucher][created]	DateTime	*
_exchange_bonus_request[_voucher][updated]	DateTime	*
_exchange_bonus_request[_voucher][_currency]	object (Currency)	*
_exchange_bonus_request[_voucher][_status]	object (VoucherStatus)	*
_exchange_bonus_request[_voucher][_exchange_bonus_request]	object (ExchangeBonusRequest)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/vouchers/{voucher_id}

DELETE /accounts/{account_slug}/vouchers/{voucher_id}

Delete a voucher

Documentation
Sandbox

Documentation

Delete a voucher.

Requirements

Name	Requirement	Type	Description
voucher_id	\d+	integer	the voucher id
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/vouchers/{voucher_id}

Return a voucher

Documentation
Sandbox

Documentation

Get a voucher by a given id.

Response Format

{
    "code": 200,
    "data": {
        "id": 1,
        "code": "XXX-555-XXX",
        "value": 99.99,
        "_currency": {
            "code": "USD",
            "unicode": "32",
            "currency": "United States Dollar",
            "suffix": "¢",
            "updated": "2019-08-19T22:00:55+0000"
        },
        "setting": {
            "statusLogs": "[{"status":"available","statusId":1,"date":"2020-05-12 19:29:56"}]"
        },
        "created": "2020-05-12T19:29:56+0000",
        "updated": "2020-05-12T19:29:56+0000",
        "_status": {
            "name": "Available",
            "slug": "available",
           "description": "Status when the voucher is ready to be redeemed"
        }
    }
}

Requirements

Name	Requirement	Type	Description
voucher_id	\d+	string	the voucher id
account_slug		string	the client account slug

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
code	string	*
value	float	*
setting	array	*
created	DateTime	*
updated	DateTime	*
_currency	object (Currency)	*
_currency[code]	string	*
_currency[unicode]	string	*
_currency[currency]	string	*
_currency[suffix]	string	*
_currency[updated]	DateTime	*
_status	object (VoucherStatus)	*
_status[name]	string	*
_status[slug]	string	*
_status[description]	string	*
_exchange_bonus_request	object (ExchangeBonusRequest)	*
_exchange_bonus_request[id]	integer	*
_exchange_bonus_request[amount]	float	*
_exchange_bonus_request[description]	string	*
_exchange_bonus_request[schemaless_config]	string	*
_exchange_bonus_request[setting]	array	*
_exchange_bonus_request[internal_note]	string	*
_exchange_bonus_request[created]	DateTime	*
_exchange_bonus_request[updated]	DateTime	*
_exchange_bonus_request[_bonuses][]	array of objects (Bonus)	*
_exchange_bonus_request[_bonuses][][id]	integer	*
_exchange_bonus_request[_bonuses][][amount]	float	*
_exchange_bonus_request[_bonuses][][created]	DateTime	*
_exchange_bonus_request[_bonuses][][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_currency]	object (Currency)	*
_exchange_bonus_request[_bonuses][][_advocate]	object (Advocate)	*
_exchange_bonus_request[_bonuses][][_advocate][email]	string	*
_exchange_bonus_request[_bonuses][][_advocate][lastname]	string	*
_exchange_bonus_request[_bonuses][][_advocate][name]	string	*
_exchange_bonus_request[_bonuses][][_advocate][token]	string	*
_exchange_bonus_request[_bonuses][][_advocate][short_token]	string	*
_exchange_bonus_request[_bonuses][][_advocate][code]	string	*
_exchange_bonus_request[_bonuses][][_advocate][payout_threshold]	float	*
_exchange_bonus_request[_bonuses][][_advocate][claimed_balance]	float	*
_exchange_bonus_request[_bonuses][][_advocate][unclaimed_balance]	float	*
_exchange_bonus_request[_bonuses][][_advocate][total_referrals]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][total_bonuses]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][total_clicks]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][total_shares]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][avatar_url]	string	*
_exchange_bonus_request[_bonuses][][_advocate][metadata]	string	*
_exchange_bonus_request[_bonuses][][_advocate][can_refer]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][status]	string	*
_exchange_bonus_request[_bonuses][][_advocate][status_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][setting]	array	*
_exchange_bonus_request[_bonuses][][_advocate][is_email_confirmed]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][fraudulent]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][_advocate_referrer]	object (Advocate)	*
_exchange_bonus_request[_bonuses][][_advocate][_currency]	object (Currency)	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method][name]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method][description]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_bonuses_redemption_method][slug]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract]	object (Campaign)	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][name]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][description]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][start_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][end_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][is_active]	boolean	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][schemaless_config]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][slug]	string	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][total_advocates]	integer	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][startDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][endDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][isActive]	bool	*
_exchange_bonus_request[_bonuses][][_advocate][_campaign_contract][schemalessConfig]		*
_exchange_bonus_request[_bonuses][][_advocate][_campaign]	object (Campaign)	*
_exchange_bonus_request[_bonuses][][_referred_advocate]	object (Advocate)	*
_exchange_bonus_request[_bonuses][][bonus_request_trace]	object (BonusRequestTrace)	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][id]	integer	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][trace]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][message]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][reference]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][created]	DateTime	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][advocate_referrer_token]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][advocate_token]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][campaign_slug]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][bonus_amount]	float	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][result]	string	*
_exchange_bonus_request[_bonuses][][bonus_request_trace][bonuses][]	array of objects (Bonus)	*
_exchange_bonus_request[_bonuses][][referred_advocate_token]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_full_name]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_email]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_currency_code]	string	*
_exchange_bonus_request[_bonuses][][referred_advocate_can_refer]	boolean	*
_exchange_bonus_request[_bonuses][][redemption_request_id]	integer	*
_exchange_bonus_request[_bonuses][][_bonus_type]	object (BonusType)	*
_exchange_bonus_request[_bonuses][][_bonus_type][name]	string	*
_exchange_bonus_request[_bonuses][][_bonus_type][description]	string	*
_exchange_bonus_request[_bonuses][][_bonus_type][slug]	string	*
_exchange_bonus_request[_bonuses][][reference]	string	*
_exchange_bonus_request[_bonuses][][payment_amount]	float	*
_exchange_bonus_request[_bonuses][][status]	string	*
_exchange_bonus_request[_bonuses][][status_date]	DateTime	*
_exchange_bonus_request[_bonuses][][setting]	array	*
_exchange_bonus_request[_bonuses][][_tags][]	array of objects (Tag)	*
_exchange_bonus_request[_bonuses][][_tags][][name]	string	*
_exchange_bonus_request[_bonuses][][_tags][][slug]	string	*
_exchange_bonus_request[_bonuses][][_tags][][description]	string	*
_exchange_bonus_request[_bonuses][][_tags][][color]	string	*
_exchange_bonus_request[_bonuses][][_tags][][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_tags][][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign]	object (Campaign)	*
_exchange_bonus_request[_bonuses][][_campaign][name]	string	*
_exchange_bonus_request[_bonuses][][_campaign][description]	string	*
_exchange_bonus_request[_bonuses][][_campaign][start_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][end_date]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][is_active]	boolean	*
_exchange_bonus_request[_bonuses][][_campaign][schemaless_config]	string	*
_exchange_bonus_request[_bonuses][][_campaign][created]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][updated]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][slug]	string	*
_exchange_bonus_request[_bonuses][][_campaign][total_advocates]	integer	*
_exchange_bonus_request[_bonuses][][_campaign][startDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][endDate]	DateTime	*
_exchange_bonus_request[_bonuses][][_campaign][isActive]	bool	*
_exchange_bonus_request[_bonuses][][_campaign][schemalessConfig]		*
_exchange_bonus_request[_advocate]	object (Advocate)	*
_exchange_bonus_request[_advocate][email]	string	*
_exchange_bonus_request[_advocate][lastname]	string	*
_exchange_bonus_request[_advocate][name]	string	*
_exchange_bonus_request[_advocate][token]	string	*
_exchange_bonus_request[_advocate][short_token]	string	*
_exchange_bonus_request[_advocate][code]	string	*
_exchange_bonus_request[_advocate][payout_threshold]	float	*
_exchange_bonus_request[_advocate][claimed_balance]	float	*
_exchange_bonus_request[_advocate][unclaimed_balance]	float	*
_exchange_bonus_request[_advocate][total_referrals]	integer	*
_exchange_bonus_request[_advocate][total_bonuses]	integer	*
_exchange_bonus_request[_advocate][created]	DateTime	*
_exchange_bonus_request[_advocate][updated]	DateTime	*
_exchange_bonus_request[_advocate][total_clicks]	integer	*
_exchange_bonus_request[_advocate][total_shares]	integer	*
_exchange_bonus_request[_advocate][avatar_url]	string	*
_exchange_bonus_request[_advocate][metadata]	string	*
_exchange_bonus_request[_advocate][can_refer]	boolean	*
_exchange_bonus_request[_advocate][status]	string	*
_exchange_bonus_request[_advocate][status_date]	DateTime	*
_exchange_bonus_request[_advocate][setting]	array	*
_exchange_bonus_request[_advocate][is_email_confirmed]	boolean	*
_exchange_bonus_request[_advocate][fraudulent]	boolean	*
_exchange_bonus_request[_advocate][_advocate_referrer]	object (Advocate)	*
_exchange_bonus_request[_advocate][_currency]	object (Currency)	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method]	object (BonusExchangeMethod)	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method][name]	string	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method][description]	string	*
_exchange_bonus_request[_advocate][_bonuses_redemption_method][slug]	string	*
_exchange_bonus_request[_advocate][_campaign_contract]	object (Campaign)	*
_exchange_bonus_request[_advocate][_campaign_contract][name]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][description]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][start_date]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][end_date]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][is_active]	boolean	*
_exchange_bonus_request[_advocate][_campaign_contract][schemaless_config]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][created]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][updated]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][slug]	string	*
_exchange_bonus_request[_advocate][_campaign_contract][total_advocates]	integer	*
_exchange_bonus_request[_advocate][_campaign_contract][startDate]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][endDate]	DateTime	*
_exchange_bonus_request[_advocate][_campaign_contract][isActive]	bool	*
_exchange_bonus_request[_advocate][_campaign_contract][schemalessConfig]		*
_exchange_bonus_request[_advocate][_campaign]	object (Campaign)	*
_exchange_bonus_request[request_action_slug]	string	*
_exchange_bonus_request[request_action_name]	string	*
_exchange_bonus_request[request_status_slug]	string	*
_exchange_bonus_request[request_status_name]	string	*
_exchange_bonus_request[status_date]	DateTime	*
_exchange_bonus_request[currency_code]	string	*
_exchange_bonus_request[advocates_paypal_username]	string	*
_exchange_bonus_request[_voucher]	object (Voucher)	*
_exchange_bonus_request[_voucher][id]	integer	*
_exchange_bonus_request[_voucher][code]	string	*
_exchange_bonus_request[_voucher][value]	float	*
_exchange_bonus_request[_voucher][setting]	array	*
_exchange_bonus_request[_voucher][created]	DateTime	*
_exchange_bonus_request[_voucher][updated]	DateTime	*
_exchange_bonus_request[_voucher][_currency]	object (Currency)	*
_exchange_bonus_request[_voucher][_status]	object (VoucherStatus)	*
_exchange_bonus_request[_voucher][_exchange_bonus_request]	object (ExchangeBonusRequest)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /accounts/{account_slug}/vouchers/{voucher_id}

Update a voucher

Documentation
Sandbox

Documentation

Update partial elements of a voucher. Use this method when you do not need to update all the elements at the same time.

Allowed parameters to be updated are: status

Request Format

{
"status": "available"
}

Requirements

Name	Requirement	Type	Description
voucher_id	\d+	string	the voucher id
account_slug		string	the client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Widgets Packages

/accounts/{account_slug}/widgets-packages

GET /accounts/{account_slug}/widgets-packages

Get widgets packages

Documentation
Sandbox

Documentation

Get the list of widgets packages.

Response Format

 {
     "code": 200,
     "data": {
         "page": 1,
         "limit": 10,
         "total": 1,
         "results": [
             {
                 "name": "Get $ 5 on first order",
                 "slug": "get-5-on-first-order-191",
                 "description": "This is the description",
                 "landing_url": "http://www.geniusreferrals.com/refer-a-friend",
                 "locale": "en_US",
                 "created": "2014-04-05T16:54:52+0000",
                 "updated": "2014-04-05T16:54:52+0000",
                 "_campaign": {
                     "name": "Get $ 5 on first order",
                     "description": "Get $ 5 on first order",
                     "start_date": "2014-04-05T16:54:20+0000",
                     "is_active": true,
                     "schemaless_config": "schemaless config goes here",
                     "created": "2014-04-05T16:54:20+0000",
                     "updated": "2014-04-05T16:54:20+0000",
                     "slug": "get-5-on-first-order-221",
                     "total_advocates": 2
                 }
             }
         ]
     }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: name, campaign_slug, from, to, created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: campaign_slug, created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
slug	string	*
description	string	*
landing_url	string	*
locale	string	*
created	DateTime	*
updated	DateTime	*
_campaign	object (Campaign)	*
_campaign[name]	string	*
_campaign[description]	string	*
_campaign[start_date]	DateTime	*
_campaign[end_date]	DateTime	*
_campaign[is_active]	boolean	*
_campaign[schemaless_config]	string	*
_campaign[created]	DateTime	*
_campaign[updated]	DateTime	*
_campaign[slug]	string	*
_campaign[total_advocates]	integer	*
_campaign[startDate]	DateTime	*
_campaign[endDate]	DateTime	*
_campaign[isActive]	bool	*
_campaign[schemalessConfig]		*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/widgets-packages

Create an new widgets package

Documentation
Sandbox

Documentation

Create a new widgets package.

Request Format

All parameters are mandatory.

 {
     "widgets_package": {
         "name": "Get $10 after sign up",
         "description": "Get $10 after one of your friends sign up with our service",
         "campaign_slug": "get-10-of-for-90-days",
         "locale": "en_US",
         "landing_url": "http://www.geniusreferrals.com/refer-a-friend"
     }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	The client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/widgets-packages/{widgets_package_slug}

DELETE /accounts/{account_slug}/widgets-packages/{widgets_package_slug}

delete a widgets package

Documentation
Sandbox

Documentation

Delete a widgets package.

Requirements

Name	Requirement	Type	Description
account_slug		string	The client account slug
widgets_package_slug		string	The account widget slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/widgets-packages/{widgets_package_slug}

get a widgets package

Documentation
Sandbox

Documentation

Get a widgets package.

Response Format

 {
     "code": 200,
     "data": {
         "name": "Get $ 5 on first order",
         "slug": "get-5-on-first-order-191",
         "description": "This is the description",
         "landing_url": "http://www.geniusreferrals.com/refer-a-friend",
         "locale": "en_US",
         "created": "2014-04-05T16:54:52+0000",
         "updated": "2014-04-05T16:54:52+0000",
         "_campaign": {
             "name": "Get $ 5 on first order",
             "description": "Get $ 5 on first order",
             "start_date": "2014-04-05T16:54:20+0000",
             "is_active": true,
             "schemaless_config": "schemaless config goes here",
             "created": "2014-04-05T16:54:20+0000",
             "updated": "2014-04-05T16:54:20+0000",
             "slug": "get-5-on-first-order-221",
             "total_advocates": 2
         }
     }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	The client account slug
widgets_package_slug		string	The account widget slug

Return

Parameter	Type	Versions
200 - Returned when successful
name	string	*
slug	string	*
description	string	*
landing_url	string	*
locale	string	*
created	DateTime	*
updated	DateTime	*
_campaign	object (Campaign)	*
_campaign[name]	string	*
_campaign[description]	string	*
_campaign[start_date]	DateTime	*
_campaign[end_date]	DateTime	*
_campaign[is_active]	boolean	*
_campaign[schemaless_config]	string	*
_campaign[created]	DateTime	*
_campaign[updated]	DateTime	*
_campaign[slug]	string	*
_campaign[total_advocates]	integer	*
_campaign[startDate]	DateTime	*
_campaign[endDate]	DateTime	*
_campaign[isActive]	bool	*
_campaign[schemalessConfig]		*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /accounts/{account_slug}/widgets-packages/{widgets_package_slug}

Update a widgets package

Documentation
Sandbox

Documentation

Update a widgets package.

Request Format

All parameters are mandatory.

 {
     "widgets_package": {
         "name": "Get $10 after sign up",
         "description": "Get $10 after one of your friends sign up with our service",
         "campaign_slug": "get-10-of-for-90-days",
         "locale": "en_US",
         "landing_url": "http://www.geniusreferrals.com/refer-a-friend"
     }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	The client account slug
widgets_package_slug		string	The client account slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets

GET /accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets

Get widgets

Documentation
Sandbox

Documentation

Get list of widgets.

Response Format

 {
     "code": 200,
     "data": [
         {
             "id": 47,
             "content": "{
                 \"images\":null,
                 \"title\":null,
                 \"summary\":\"I just found out about this and wanted to share it with you. Check it out!\",
                 \"source\":null,
                 \"site_name\":null,
                 \"author_url\":null,
                 \"publisher_url\":null
             }",
             "created": "2014-04-06T20:00:17+0000",
             "updated": "2014-04-06T20:00:17+0000",
             "_referral_origin": {
                 "description": "Twitter website post",
                 "name": "Twitter Post",
                 "slug": "twitter-post"
             },
             "_widgets_package": {
                 "name": "Get $ 5 on first order",
                 "slug": "get-5-on-first-order-191",
                 "description": "This is the description",
                 "landing_url": "http://www.geniusreferrals.com/refer-a-friend",
                 "locale": "en_US",
                 "created": "2014-04-05T16:54:52+0000",
                 "updated": "2014-04-05T16:54:52+0000",
                 "_campaign": {
                     "name": "Get $ 5 on first order",
                     "description": "Get $ 5 on first order",
                     "start_date": "2014-04-05T16:54:20+0000",
                     "is_active": true,
                     "schemaless_config": "schemaless config goes here",
                     "created": "2014-04-05T16:54:20+0000",
                     "updated": "2014-04-05T16:54:20+0000",
                     "slug": "get-5-on-first-order-221",
                     "total_advocates": 2
                 }
             }
         },
         {
             "id": 48,
             "active": true,
             "content": "{
                 \"images\":[\"http:\\/\\/78377cae187d6f42ec8b-2977c39e5e9390b1a89ab5ed2a171102.r74.cf1.rackcdn.com\\/assets\\/img\\/socials\\/en\\/social_widgets_default_image.png\"],
                 \"title\":\"It looks like this is something you might be interested in\,
                 \"summary\":\"I just found out about this and wanted to share it with you. Check it out!\",
                 \"source\":null,
                 \"site_name\":null,
                 \"author_url\":null,
                 \"publisher_url\":null,
             }",
             "created": "2014-04-06T20:00:17+0000",
             "updated": "2014-04-06T20:00:17+0000",
             "_referral_origin": {
                 "description": "Facebook Share",
                 "name": "Facebook website share",
                 "slug": "facebook-share"
             },
             "_widgets_package": {
                 "name": "Get $ 5 on first order",
                 "slug": "get-5-on-first-order-191",
                 "description": "This is the description",
                 "landing_url": "http://www.geniusreferrals.com/refer-a-friend",
                 "locale": "en_US",
                 "created": "2014-04-05T16:54:52+0000",
                 "updated": "2014-04-05T16:54:52+0000",
                 "_campaign": {
                     "name": "Get $ 5 on first order",
                     "description": "Get $ 5 on first order",
                     "start_date": "2014-04-05T16:54:20+0000",
                     "is_active": true,
                     "schemaless_config": "schemaless config goes here",
                     "created": "2014-04-05T16:54:20+0000",
                     "updated": "2014-04-05T16:54:20+0000",
                     "slug": "get-5-on-first-order-221",
                     "total_advocates": 2
                 }
             }
         }
     ]
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	the client account slug
widgets_package_slug		string	the account widget slug

Filters

Name

Information

filter

Requirement

Description

Allowed fields: locale. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\/users?filter='name::todd|city::denver|title::grand poobah'

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
active	boolean	*
content	string	*
created	DateTime	*
updated	DateTime	*
_referral_origin	object (ReferralOrigin)	*
_referral_origin[name]	string	*
_referral_origin[description]	string	*
_referral_origin[slug]	string	*
_widgets_package	object (WidgetsPackage)	*
_widgets_package[name]	string	*
_widgets_package[slug]	string	*
_widgets_package[description]	string	*
_widgets_package[landing_url]	string	*
_widgets_package[locale]	string	*
_widgets_package[created]	DateTime	*
_widgets_package[updated]	DateTime	*
_widgets_package[_campaign]	object (Campaign)	*
_widgets_package[_campaign][name]	string	*
_widgets_package[_campaign][description]	string	*
_widgets_package[_campaign][start_date]	DateTime	*
_widgets_package[_campaign][end_date]	DateTime	*
_widgets_package[_campaign][is_active]	boolean	*
_widgets_package[_campaign][schemaless_config]	string	*
_widgets_package[_campaign][created]	DateTime	*
_widgets_package[_campaign][updated]	DateTime	*
_widgets_package[_campaign][slug]	string	*
_widgets_package[_campaign][total_advocates]	integer	*
_widgets_package[_campaign][startDate]	DateTime	*
_widgets_package[_campaign][endDate]	DateTime	*
_widgets_package[_campaign][isActive]	bool	*
_widgets_package[_campaign][schemalessConfig]		*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets

Create a widget

Documentation
Sandbox

Documentation

Create a new widget.

Request Format

Only parameters referral_origin_slug is mandatory.

 {
     "widget":
     {
         "referral_origin_slug":"facebook-share",
         "images":["http://78377cae187d6f42ec8b-2977c39e5e9390b1a89ab5ed2a171102.r74.cf1.rackcdn.com/assets/img/socials/en/social_widgets_default_image.png"],
         "locale" : "en_US",
         "active" : true,
         "title":"Very good service to increase your customer acquisition!!!",
         "summary":"Genius Referrals really help us to acquire new customers at a very low price.  Check it out for yourself. ",
         "site_name":"Genius Referrals",
         "card_title": "MyCompany",
         "card_description": "Increase your customer acquisition and sales with ours refer and friend programs."
    }
 }

Requirements

Name	Requirement	Type	Description
account_slug		string	The client account slug
widgets_package_slug		string	The account widget slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets/{widget_id}

GET /accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets/{widget_id}

Get a widget

Documentation
Sandbox

Documentation

Get a widget by the given parameters.

Response Format

 {
     "code": 200,
     "data": {
         "id": 48,
         "active": true,
         "content": "{
             \"images\":[\"http:\\/\\/78377cae187d6f42ec8b-2977c39e5e9390b1a89ab5ed2a171102.r74.cf1.rackcdn.com\\/assets\\/img\\/socials\\/en\\/social_widgets_default_image.png\"],
             \"title\":\"It looks like this is something you might be interested in\,
             \"summary\":\"I just found out about this and wanted to share it with you. Check it out!\",
             \"source\":null,
             \"site_name\":null,
             \"author_url\":null,
             \"publisher_url\":null
         }",
         "created": "2014-04-06T20:00:17+0000",
         "updated": "2014-04-06T20:00:17+0000",
         "_referral_origin": {
             "description": "Facebook Share",
             "name": "Facebook website share",
             "slug": "facebook-share"
         },
         "_widgets_package": {
             "name": "Get $ 5 on first order",
             "slug": "get-5-on-first-order-191",
             "description": "This is the description",
             "landing_url": "http://www.geniusreferrals.com/refer-a-friend",
             "locale": "en_US",
             "created": "2014-04-05T16:54:52+0000",
             "updated": "2014-04-05T16:54:52+0000",
             "_campaign": {
                 "name": "Get $ 5 on first order",
                 "description": "Get $ 5 on first order",
                 "start_date": "2014-04-05T16:54:20+0000",
                 "is_active": true,
                 "schemaless_config": "schemaless config goes here",
                 "created": "2014-04-05T16:54:20+0000",
                 "updated": "2014-04-05T16:54:20+0000",
                 "slug": "get-5-on-first-order-221",
                 "total_advocates": 2
             }
         }
     }
 }

Requirements

Name	Requirement	Type	Description
widget_id	\d+	string	The account widget id
account_slug		string	The client account slug
widgets_package_slug		string	The account widget slug

Filters

Name

Information

filter

Requirement

Description

Return

Parameter	Type	Versions
200 - Returned when successful
id	integer	*
active	boolean	*
content	string	*
created	DateTime	*
updated	DateTime	*
_referral_origin	object (ReferralOrigin)	*
_referral_origin[name]	string	*
_referral_origin[description]	string	*
_referral_origin[slug]	string	*
_widgets_package	object (WidgetsPackage)	*
_widgets_package[name]	string	*
_widgets_package[slug]	string	*
_widgets_package[description]	string	*
_widgets_package[landing_url]	string	*
_widgets_package[locale]	string	*
_widgets_package[created]	DateTime	*
_widgets_package[updated]	DateTime	*
_widgets_package[_campaign]	object (Campaign)	*
_widgets_package[_campaign][name]	string	*
_widgets_package[_campaign][description]	string	*
_widgets_package[_campaign][start_date]	DateTime	*
_widgets_package[_campaign][end_date]	DateTime	*
_widgets_package[_campaign][is_active]	boolean	*
_widgets_package[_campaign][schemaless_config]	string	*
_widgets_package[_campaign][created]	DateTime	*
_widgets_package[_campaign][updated]	DateTime	*
_widgets_package[_campaign][slug]	string	*
_widgets_package[_campaign][total_advocates]	integer	*
_widgets_package[_campaign][startDate]	DateTime	*
_widgets_package[_campaign][endDate]	DateTime	*
_widgets_package[_campaign][isActive]	bool	*
_widgets_package[_campaign][schemalessConfig]		*

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets/{widget_id}

Update a widget

Documentation
Sandbox

Documentation

Update the widget status.

Allowed parameter to be updated is: active

Request Format

{
    "active": true
}

Requirements

Name	Requirement	Type	Description
widget_id	\d+	integer	The widget id to be updated
account_slug		string	The client account slug
widgets_package_slug		string	The account widget slug

Status Codes

Status Code	Description
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets/{widget_id}

Update a widget

Documentation
Sandbox

Documentation

Update a widget.

Request Format

Only parameters referral_origin_slug is mandatory.

 {
     "widget":
     {
         "referral_origin_slug":"facebook-share",
         "images":[http://78377cae187d6f42ec8b-2977c39e5e9390b1a89ab5ed2a171102.r74.cf1.rackcdn.com/assets/img/socials/en/social_widgets_default_image.png"],
         "locale" : "en_US",
         "active" : true,
         "title":"Very good service to increase your customer acquisition!!!",
         "summary":"Genius Referrals really help us to acquire new customers at a very low price.  Check it out for yourself. ",
         "site_name":"Genius Referrals",
         "card_title": "MyCompany",
         "card_description": "Increase your customer acquisition and sales with ours refer and friend programs."
     }
 }

Requirements

Name	Requirement	Type	Description
widget_id	\d+	integer	The widget id to be updated
account_slug		string	The client account slug
widgets_package_slug		string	The account widget slug

Status Codes

Status Code	Description
401	You are not authenticated
403	User not authorized to perform the operation
201	Resource created successful
200	Returned when successful
400	Request could not be understood

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets/{widget_id}/translations

POST /accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets/{widget_id}/translations

Update a widget

Documentation
Sandbox

Documentation

Translate a widget content in the given language.

Request Format

Only parameters referral_origin_slug is mandatory.

{
    "widget": {
        "referral_origin_slug":"facebook-like",
        "images": [
            "http:\/\/www.photographised.com\/temp\/img\/Ballast%20Bank%20Sunset.jpg",
            "https:\/\/pbs.twimg.com\/media\/BHdHhB2CQAAFXCu.jpg"
        ],
        "locale" : "en_US",
        "title":"Very good service to increase your customer acquisition!!!",
        "summary":"Genius Referrals really help us to acquire new customers at a very low price.  Check it out for yourself. ",
        "site_name":"Genius Referrals",
        "author_url":"https:\/\/www.facebook.com\/alain.hernandez.5623",
        "publisher_url":"https:\/\/www.facebook.com\/gref_co"
    }
}

Requirements

Name	Requirement	Type	Description
widget_id	\d+	integer	The widget id to be updated
account_slug		string	The client account slug
widgets_package_slug		string	The account widget slug

Status Codes

Status Code	Description
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets/{widget_id}/translations/{locale}

PATCH /accounts/{account_slug}/widgets-packages/{widgets_package_slug}/widgets/{widget_id}/translations/{locale}

Update a widget

Documentation
Sandbox

Documentation

Update partial elements of a widget in the given language.

Allowed parameters to be updated are: title, summary, card_title and card_description

Request Format

{
    "title":"Very good service to increase your customer acquisition!!!",
    "summary":"Genius Referrals really help us to acquire new customers at a very low price.  Check it out for yourself. ",
    "card_title": "MyCompany",
    "card_description": "Increase your customer acquisition and sales with ours refer and friend programs."
}

Requirements

Name	Requirement	Type	Description
widget_id	\d+	integer	The widget id to be updated
account_slug
widgets_package_slug		string	The account widget slug
locale		string	The widget locale

Status Codes

Status Code	Description
403	User not authorized to perform the operation
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Documentation auto-generated on Fri, 26 Apr 24 11:38:34 +0000

GENIUS REFERRALS API DOCUMENTATION

Genius Referrals Web API

Using SANDBOX

LIST OF AVAILABLE RESOURCES:

Accounts

/accounts

GET /accounts

Documentation

Filters

Return

200 - Returned when successful

Status Codes

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}

GET /accounts/{account_slug}

Documentation

Requirements

Return

200 - Returned when successful

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Advocates

/accounts/{account_slug}/advocates

DELETE /accounts/{account_slug}/advocates

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/advocates

Documentation

Requirements

Filters

Return

200 - Returned when successful

Status Codes

Requirements

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /accounts/{account_slug}/advocates

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/accounts/{account_slug}/advocates/{advocate_token}

DELETE /accounts/{account_slug}/advocates/{advocate_token}

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /accounts/{account_slug}/advocates/{advocate_token}

Documentation