affiliate

Enroll in the affiliate program

Enroll the caller's workspace, idempotently: enrolling twice returns the existing profile. Open self-serve: the program's gates live at payout, not at the door. Requires a signed-in user rather than an API key, because enrollment records who the affiliate is.

post/affiliate/enroll/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/affiliate/enroll/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

display_namestring required

The name shown to referred users in welcome copy.

Response

Successful Response

contact_emailstring required
created_atstring date-time required
display_namestring required
idstring uuid required
identity_verified_atstring date-time nullable required
paypal_emailstring nullable required
paypal_email_confirmed_atstring date-time nullable required
status'active' | 'suspended' | 'banned' required

Whether an affiliate may earn and be paid.

Changes

No recorded changes to this operation across all 1 revision of this API.