Sign in

v7

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-06-23254073.9 KB
Participants

Add participant

Adds a new participant to the program. If the email already exists, the existing participant is returned.

post/campaign/{id}/participant

Path parameters

idstring required

GrowSurf program ID.

Request body

emailstring email required
referredBystring

Referrer participant ID or email address.

referralStatus'CREDIT_PENDING' | 'CREDIT_AWARDED'
firstNamestring
lastNamestring
ipAddressstring
fingerprintstring
mobileInstanceIdstring

Optional app-install scoped identifier for native mobile anti-fraud. Recommended for mobile participant creation and mobile participant token flows. The official mobile SDKs generate this as a lowercase UUID.

metadataMetadata

Shallow custom metadata object.

Response

Participant returned.

idstring required
firstNamestring nullable
lastNamestring nullable
emailstring required
paypalEmailAddressstring email
referralCountinteger required
monthlyReferralCountinteger required
prevMonthlyReferralCountinteger
rankinteger required
monthlyRankinteger required
prevMonthlyRankinteger
shareUrlstring required
createdAtinteger
referralSource'DIRECT' | 'PARTICIPANT'
referralStatus'CREDIT_PENDING' | 'CREDIT_AWARDED' | 'CREDIT_EXPIRED' | 'INVITE_SENT'
referredBystring
fraudRiskLevel'LOW' | 'MEDIUM' | 'HIGH'
fraudReasonCodestring
isWinnerboolean
shareCountobject
impressionCountinteger
uniqueImpressionCountinteger
inviteCountinteger
referralsstring[]
monthlyReferralsstring[]
ipAddressstring nullable
fingerprintstring nullable
mobileInstanceIdstring nullable

App-install scoped mobile identifier used for anti-fraud matching when provided by native mobile apps. The official mobile SDKs generate this as a lowercase UUID. Not stored when strict GDPR/CCPA mode is enabled.

metadataMetadata

Shallow custom metadata object.

notesstring nullable
unsubscribedboolean
vanityKeysstring[]
unreadCommissionsCountinteger
unreadPayoutsCountinteger
isNewboolean
allMatchingFraudstersobject[]