Sign in
Participants

Update participant

Updates a participant by GrowSurf participant ID or email address.

post/campaign/{id}/participant/{participantIdOrEmail}

Path parameters

idstring required

GrowSurf program ID.

participantIdOrEmailstring required

GrowSurf participant ID or URL-encoded participant email address.

Request body

referredBystring
emailstring email
firstNamestring
lastNamestring
metadataMetadata

Shallow custom metadata object.

referralStatus'CREDIT_PENDING' | 'CREDIT_AWARDED' | 'CREDIT_EXPIRED'
vanityKeysstring[]
unsubscribedboolean

Response

Updated 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[]

Changes

Changed in 2 of the 7 revisions of this API.2

  • 26f06e2733941See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 5315da9cd1a61See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added