Skip to main content
POST
Create affiliate
Required permissions:
  • affiliate:create

Autorisations

Authorization
string
header
requis

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

affiliate:create

Corps

application/json

Parameters for CreateAffiliateRecord

account_id
string
requis

The ID of the company to create the affiliate for.

Exemple:

"biz_xxxxxxxxxxxxxx"

user_identifier
string
requis

The user identifier (username, email, user ID, or Discord ID).

Réponse

A successful response

An affiliate tracks a user's referral performance and commission earnings for a company, including retention rates, revenue metrics, and payout configurations.

active_members_count
integer
requis

The total active members of the affiliate

Exemple:

42

company
object
requis

The company attached to this affiliate

created_at
string<date-time>
requis

The datetime the affiliate was created.

Exemple:

"2023-12-01T05:00:00.401Z"

customer_retention_rate
string
requis

The percentage of referred customers who are still active members

customer_retention_rate_ninety_days
string
requis

The percentage of referred customers who remained active over the last 90 days

id
string
requis

The unique identifier for the affiliate.

Exemple:

"aff_xxxxxxxxxxxxxx"

monthly_recurring_revenue_usd
string
requis

The monthly recurring revenue generated by this affiliate's referrals, formatted as a USD currency string

status
enum<string> | null
requis

The status of the affiliate

Options disponibles:
active,
archived,
deleted
total_overrides_count
integer
requis

The total count of all overrides for this affiliate

Exemple:

42

total_referral_earnings_usd
string
requis

The total commission earnings paid to this affiliate, formatted as a USD currency string

total_referrals_count
integer
requis

The total referrals of the affiliate

Exemple:

42

total_revenue_usd
string
requis

The total revenue generated from this affiliate's referrals, formatted as a USD currency string

updated_at
string<date-time>
requis

The datetime the affiliate was last updated.

Exemple:

"2023-12-01T05:00:00.401Z"

user
object
requis

The user attached to this affiliate