Private API Reference

Simulated Referral OAuth Codes

Simulate your user completing the Referral OAuth flow. The code returned can be exchanged using POST /oauth/tokens for an access token. The access token can be used in Sandbox to make API calls as if a brand-new user registered. In production, the code is returned to your website via the callback URL.

The Simulated Referral OAuth Code object

{
  "code": "sk5eyg"
}

Attributes

code

string

The OAuth code to be exchanged for an access token.

Sandbox: Simulate the Referral OAuth flow

This endpoint simulates the Referral OAuth flow. Invoke it with your application’s client ID to receive a code that can be exchanged for an access token.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/referral_oauth_code_create" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "client_id": "client_id_ie2s7i"
  }'

Parameters

client_id

string

Required

The Client ID of your OAuth application.

Between 1 and 200 characters