Participants

Trigger referral

Triggers referral credit for an existing referred participant by GrowSurf participant ID or email address.

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

Request

Base URL
https://api.growsurf.com/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/growsurf/apis/growsurf-rest-api/docs/campaign/:id/participant/:participantIdOrEmail/ref/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

GrowSurf program ID.

participantIdOrEmailstring required

GrowSurf participant ID or URL-encoded participant email address.

Referral trigger result returned.

successboolean required

messagestring

No recorded changes to this operation across all 7 revisions of this API.