Skip to main content
POST
Enroll in the affiliate program

Authorizations

X-API-Key
string
header
required

Body

application/json

The one thing enrollment asks for: what to call the affiliate.

display_name
string
required

The name shown to referred users in welcome copy.

Required string length: 1 - 255

Response

Successful Response

The caller's own standing in the affiliate program.

contact_email
string
required
created_at
string<date-time>
required
display_name
string
required
id
string<uuid>
required
identity_verified_at
string<date-time> | null
required
paypal_email
string | null
required
paypal_email_confirmed_at
string<date-time> | null
required
status
enum<string>
required

Whether an affiliate may earn and be paid.

Available options:
active,
suspended,
banned