{"version":1,"pages":[{"id":"-M8QpDYHkVHDgG0fixdO","title":"Introduction","pathname":"/","siteSpaceId":"sitesp_Qh8f6","description":""},{"id":"-MAwjlqOJR-yVLPbPtGi","title":"Overview","pathname":"/javascript-api/overview","siteSpaceId":"sitesp_Qh8f6","description":"Introduction to Rewardful's JavaScript API","breadcrumbs":[{"label":"JavaScript API"}]},{"id":"-M8wsYDSE5jhcpkaxBHP","title":"Overview","pathname":"/rest-api/overview","siteSpaceId":"sitesp_Qh8f6","description":"Introduction to Rewardful's REST API","breadcrumbs":[{"label":"REST API"}]},{"id":"XywrznndC90neoTDUDG5","title":"Campaigns","pathname":"/rest-api/campaigns","siteSpaceId":"sitesp_Qh8f6","description":"Create, retrieve, and update campaigns through REST API calls.","breadcrumbs":[{"label":"REST API"}]},{"id":"FVb8vNEQWwEeuUUf16F6","title":"The campaign object","pathname":"/rest-api/campaigns/the-campaign-object","siteSpaceId":"sitesp_Qh8f6","description":"A campaign represents a specific program offer with its own display settings and rules that affiliates may register to promote.","breadcrumbs":[{"label":"REST API"},{"label":"Campaigns"}]},{"id":"S4y25bH0JvlVkFH9EpWk","title":"List campaigns","pathname":"/rest-api/campaigns/list-campaigns","siteSpaceId":"sitesp_Qh8f6","description":"Returns a list of all your campaigns.","breadcrumbs":[{"label":"REST API"},{"label":"Campaigns"}]},{"id":"AZ15KrMMC5g9IXzIXLLs","title":"Create campaign","pathname":"/rest-api/campaigns/create-campaign","siteSpaceId":"sitesp_Qh8f6","description":"Creates a new campaign in your account with the specified parameters.","breadcrumbs":[{"label":"REST API"},{"label":"Campaigns"}]},{"id":"sEKStMJuBd0oZa3XYWTq","title":"Retrieve campaign","pathname":"/rest-api/campaigns/retrieve-campaign","siteSpaceId":"sitesp_Qh8f6","description":"Retrieves the details of an existing campaign specified by its unique identifier.","breadcrumbs":[{"label":"REST API"},{"label":"Campaigns"}]},{"id":"kUxIAGDaRLmFJAD6WgWl","title":"Update campaign","pathname":"/rest-api/campaigns/update-campaign","siteSpaceId":"sitesp_Qh8f6","description":"Updates the specified campaign by setting the values of the parameters passed. Any parameters not provided will be left unchanged.","breadcrumbs":[{"label":"REST API"},{"label":"Campaigns"}]},{"id":"-M8x2Gx1S1_nm7oTNUjs","title":"Affiliates","pathname":"/rest-api/affiliates","siteSpaceId":"sitesp_Qh8f6","description":"Create, retrieve, and update affiliates through REST API calls.","breadcrumbs":[{"label":"REST API"}]},{"id":"-M8x2TZCNLtrP2vjIEMA","title":"The affiliate object","pathname":"/rest-api/affiliates/object","siteSpaceId":"sitesp_Qh8f6","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Affiliates"}]},{"id":"-MFvzSRk8Nh5bS0uCmJN","title":"List affiliates","pathname":"/rest-api/affiliates/list","siteSpaceId":"sitesp_Qh8f6","description":"Returns a list of your affiliates. The affiliates are returned sorted by creation date, with the most recent affiliates appearing first. The list can also be filtered using various criteria.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliates"}]},{"id":"-M8x2mbZTGB4pc8Ub-NO","title":"Create affiliate","pathname":"/rest-api/affiliates/create","siteSpaceId":"sitesp_Qh8f6","description":"Creates a new affiliate in your account with the specified parameters.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliates"}]},{"id":"-M8xJU1WjTsCCizKWNd2","title":"Retrieve affiliate","pathname":"/rest-api/affiliates/retrieve","siteSpaceId":"sitesp_Qh8f6","description":"Retrieves the details of an existing affiliate. You need only supply the unique affiliate identifier that was returned upon affiliate creation.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliates"}]},{"id":"-M8xGut4UArgEkKOL3EO","title":"Update affiliate","pathname":"/rest-api/affiliates/update","siteSpaceId":"sitesp_Qh8f6","description":"Updates the specified affiliate by setting the values of the parameters passed. Any parameters not provided will be left unchanged.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliates"}]},{"id":"-MFnXEiHSyRfrKN8d1Cq","title":"Magic Link (SSO)","pathname":"/rest-api/affiliates/sso","siteSpaceId":"sitesp_Qh8f6","description":"Retrieve a secure, one-time URL that will automatically login an affiliate to their dashboard.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliates"}]},{"id":"D9Hj3Dxsz369KimReSp0","title":"Affiliate Links","pathname":"/rest-api/affiliate-links","siteSpaceId":"sitesp_Qh8f6","description":"Create, retrieve, and update affiliate links through REST API calls.","breadcrumbs":[{"label":"REST API"}]},{"id":"5UWf9jRSW3ZgQfaYbAf4","title":"The affiliate link object","pathname":"/rest-api/affiliate-links/the-affiliate-link-object","siteSpaceId":"sitesp_Qh8f6","description":"","breadcrumbs":[{"label":"REST API"},{"label":"Affiliate Links"}]},{"id":"6tSon33YsFcMI3oTGj7z","title":"List affiliate links","pathname":"/rest-api/affiliate-links/list","siteSpaceId":"sitesp_Qh8f6","description":"Returns a list of your affiliate links. The links are returned sorted by creation date, with the most recent links appearing first.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliate Links"}]},{"id":"wsYeN2cLn9hBID6mtKxI","title":"Create affiliate link","pathname":"/rest-api/affiliate-links/create","siteSpaceId":"sitesp_Qh8f6","description":"Creates a new affiliate link in your account with the specified parameters.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliate Links"}]},{"id":"j4yPVAIB9aAQEV2qXZRY","title":"Retrieve affiliate link","pathname":"/rest-api/affiliate-links/retrieve","siteSpaceId":"sitesp_Qh8f6","description":"Retrieves the details of an existing affiliate link.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliate Links"}]},{"id":"PI33IQBhikPzF4OQmlCq","title":"Update affiliate link","pathname":"/rest-api/affiliate-links/update","siteSpaceId":"sitesp_Qh8f6","description":"Updates the specified affiliate link by setting the values of the parameters passed.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliate Links"}]},{"id":"mpsk3Fz2bgIkDdPpEOrF","title":"Affiliate Coupons","pathname":"/rest-api/affiliate-coupons","siteSpaceId":"sitesp_Qh8f6","description":"List, create, retrieve, and update affiliate coupons through REST API calls.","breadcrumbs":[{"label":"REST API"}]},{"id":"HGXJMMB2jwkKi9trtvef","title":"The affiliate coupon object","pathname":"/rest-api/affiliate-coupons/the-affiliate-coupon-object","siteSpaceId":"sitesp_Qh8f6","description":"Represents a coupon or promotion code created in the payment processor (e.g. Stripe) and assigned to an affiliate for tracking purposes.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliate Coupons"}]},{"id":"LgSBQi0v7zGkj8q03FbT","title":"List affiliate coupons","pathname":"/rest-api/affiliate-coupons/list-affiliate-coupons","siteSpaceId":"sitesp_Qh8f6","description":"Returns a paginated list of your affiliate coupons.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliate Coupons"}]},{"id":"mg1VPjDmLriw4iqUJ0ai","title":"Create affiliate coupon","pathname":"/rest-api/affiliate-coupons/create-affiliate-coupon","siteSpaceId":"sitesp_Qh8f6","description":"Creates a new affiliate coupon in your account with the specified parameters.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliate Coupons"}]},{"id":"NDVs8iTXSd1D7zfxPqM4","title":"Retrieve affiliate coupon","pathname":"/rest-api/affiliate-coupons/retrieve-affiliate-coupon","siteSpaceId":"sitesp_Qh8f6","description":"Retrieves the details of an existing affiliate coupon.","breadcrumbs":[{"label":"REST API"},{"label":"Affiliate Coupons"}]},{"id":"-M8zxTkuVe6l6IkZkSuR","title":"Referrals","pathname":"/rest-api/referrals","siteSpaceId":"sitesp_Qh8f6","description":"A referral represents a unique visitor that arrived on your website through an affiliate link, which may have gone on to become a lead or paying customer (conversion).","breadcrumbs":[{"label":"REST API"}]},{"id":"-M8zyXHR5LLpWKrzzPbh","title":"The referral object","pathname":"/rest-api/referrals/object","siteSpaceId":"sitesp_Qh8f6","description":"A referral represents a unique visit to your website that came via an affiliate link.","breadcrumbs":[{"label":"REST API"},{"label":"Referrals"}]},{"id":"-M9--dk04-O1xxsLa7lI","title":"List referrals","pathname":"/rest-api/referrals/list","siteSpaceId":"sitesp_Qh8f6","description":"Returns a list of your referrals. The referrals are returned sorted by creation date, with the most recent referrals appearing first.","breadcrumbs":[{"label":"REST API"},{"label":"Referrals"}]},{"id":"-MF8rJM3JOjQgPOGTM2-","title":"Commissions","pathname":"/rest-api/commissions","siteSpaceId":"sitesp_Qh8f6","description":"Commissions represent a reward issues to an affiliate in return for a payment made by a referred customer.","breadcrumbs":[{"label":"REST API"}]},{"id":"-MF8rVwJDa7attk2zN4s","title":"The commission object","pathname":"/rest-api/commissions/object","siteSpaceId":"sitesp_Qh8f6","description":"A commission represents a reward issued to an affiliate for a payment from a referred customer.","breadcrumbs":[{"label":"REST API"},{"label":"Commissions"}]},{"id":"-MFn5ZqF72l1IamY53cL","title":"List commissions","pathname":"/rest-api/commissions/list","siteSpaceId":"sitesp_Qh8f6","description":"Returns a list of your commissions. The commissions are returned sorted by creation date, with the most recent commissions appearing first.","breadcrumbs":[{"label":"REST API"},{"label":"Commissions"}]},{"id":"-MF8ux4sDRN_7d1uRhVw","title":"Retrieve commission","pathname":"/rest-api/commissions/retrieve","siteSpaceId":"sitesp_Qh8f6","description":"Retrieves the details of an existing commission. You need only supply the unique identifier (UUID) associated with the commission.","breadcrumbs":[{"label":"REST API"},{"label":"Commissions"}]},{"id":"-MFnBnkUq6VC6iRNJvzZ","title":"Update commission","pathname":"/rest-api/commissions/update","siteSpaceId":"sitesp_Qh8f6","description":"Updates the specified commission by setting the values of the parameters passed. Any parameters not provided will be left unchanged.","breadcrumbs":[{"label":"REST API"},{"label":"Commissions"}]},{"id":"-MFn8tvO606tiTnAUAoY","title":"Delete commission","pathname":"/rest-api/commissions/delete","siteSpaceId":"sitesp_Qh8f6","description":"Permanently deletes a commission. Financial stats for the associated affiliate and campaign will be recalculated.","breadcrumbs":[{"label":"REST API"},{"label":"Commissions"}]},{"id":"DQo1kVbsCffdvsmw2ASr","title":"Payouts","pathname":"/rest-api/payouts","siteSpaceId":"sitesp_Qh8f6","description":"Payouts represent a set of one or more due commissions owed to a given affiliate which have been or may be marked as paid collectively.","breadcrumbs":[{"label":"REST API"}]},{"id":"djV1KFBi12ugEe1F4neH","title":"The payout object","pathname":"/rest-api/payouts/the-payout-object","siteSpaceId":"sitesp_Qh8f6","description":"A payout collects a number of payable commissions for a single affiliate in one bundle.","breadcrumbs":[{"label":"REST API"},{"label":"Payouts"}]},{"id":"4TXDp4Isl9E9JjUQj4hn","title":"List payouts","pathname":"/rest-api/payouts/list-payouts","siteSpaceId":"sitesp_Qh8f6","description":"Returns a list of your payouts. Records are returned sorted by creation date, with the most recent items appearing first.","breadcrumbs":[{"label":"REST API"},{"label":"Payouts"}]},{"id":"0m1SmM2iV9GwNzS6NlzJ","title":"Retrieve a payout","pathname":"/rest-api/payouts/retrieve-a-payout","siteSpaceId":"sitesp_Qh8f6","description":"Retrieves the details of an existing payout. You need only supply the unique identifier (UUID) associated with the payout.","breadcrumbs":[{"label":"REST API"},{"label":"Payouts"}]},{"id":"XuCeqEqPxij6CyfxdT3P","title":"Mark a payout as paid","pathname":"/rest-api/payouts/mark-a-payout-as-paid","siteSpaceId":"sitesp_Qh8f6","description":"Records the specified payout and all the commissions associated with it as having been paid.","breadcrumbs":[{"label":"REST API"},{"label":"Payouts"}]},{"id":"-M8ww3ca_pUUGIsO4WJF","title":"Overview","pathname":"/webhooks/overview","siteSpaceId":"sitesp_Qh8f6","description":"An introduction to Rewardful's webhooks.","breadcrumbs":[{"label":"Webhooks"}]},{"id":"-M8wwtXkdSSgOzDCQrCn","title":"Endpoints","pathname":"/webhooks/endpoints","siteSpaceId":"sitesp_Qh8f6","description":"","breadcrumbs":[{"label":"Webhooks"}]},{"id":"-M8wxOYTgcewFswMKtje","title":"Requests","pathname":"/webhooks/requests","siteSpaceId":"sitesp_Qh8f6","description":"","breadcrumbs":[{"label":"Webhooks"}]},{"id":"-M8wyqvgc16nl2xDmB8N","title":"Event types","pathname":"/webhooks/event-types","siteSpaceId":"sitesp_Qh8f6","description":"A complete list of the webhook events Rewardful will send to your endpoints.","breadcrumbs":[{"label":"Webhooks"}]},{"id":"-M8x-eGIcjcAOWVd1R6G","title":"Signed webhooks","pathname":"/webhooks/signed-webhooks","siteSpaceId":"sitesp_Qh8f6","description":"","breadcrumbs":[{"label":"Webhooks"}]}]}