Sign in
Participants

Create mobile participant token

Creates or returns a participant using the same input behavior as Add Participant, then returns a participant-scoped token for GrowSurf mobile SDK participant endpoints. Use this endpoint from your backend after your mobile app authenticates a signed-in user. The program must have mobile SDK access enabled.

post/campaign/{id}/mobile-participant-token

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 and mobile participant token returned.

participantTokenstring required

Participant-scoped bearer token for GrowSurf mobile SDK participant endpoints.

expiresIninteger required

Token lifetime in seconds.

isNewboolean required

Whether this request created a new participant. Returns false when the participant already existed.

Changes

Changed in 3 of the 7 revisions of this API.4

  • 26f06e2733941See the full diff
    • ○

      added the optional property participant/payoutSettings to the response with the 200 status

      response-optional-property-added

  • 5315da9cd1a62See the full diff
    • ○

      added the new optional request property mobileInstanceId

      new-optional-request-property

    • ○

      added the optional property participant/mobileInstanceId to the response with the 200 status

      response-optional-property-added

  • 76c6425e193d1See the full diff
    • ○

      endpoint added

      endpoint-added