Base URL

Understand what is and how to use our REST API.

Introduction

WinWinKit

Quickstart

The most important terms and definitions.

Glossary

A program defines the rewards that users receive for inviting others and being invited.

Programs

A reward represent a level of access, feature, or content that a user is “rewarded” with.

Rewards

A user represents an individual who interacts with your app.

Users

A web url to the referral code and its rewards which your app users can share to invite new users.

Preview Link

API Keys

Swift SDK

SDK for JavaScript runtimes (React, ReactNative, Node.js, etc.).

TypeScript SDK

Learn how to authenticate your requests to the WinWinKit API.

Authentication

Learn how the WinWinKit API returns errors and handle them in your code.

Handling Errors

Create a referral user. Update the referral user if already exists.

Create Referral User

Get Referral User

Update Referral User

Claim referral code for the referral user.

Claim Referral Code

Withdraw Credits

We love to support customers, quickly. Reach out anytime.

Contact Us

Welcome to the home of your new documentation

Start building awesome documentation in under 5 minutes

Preview changes locally to update your docs

Development

Text, title, and styling in standard markdown

Markdown Syntax

Code Blocks

Add image, video, and other HTML elements

Images and Embeds

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Global Settings

The navigation field in mint.json defines the pages that go in the navigation menu

Navigation

Reusable, custom snippets to keep content in sync

Reusable Snippets

Example section for showcasing API endpoints

Creates a new referral user in the database.

Update the referral user with new properties.

Grant Basic Referral Reward

Grant Credit Referral Reward

Withdraw Credit Referral Reward

Register Push Token

Unregisters push token for referral user.

API Documentation

Referral User

Claim Referral Code

Rewards Actions

Introduction

Base URL

API Documentation

Referral User

Claim Referral Code

Rewards Actions

​Base URL

Base URL