Trigger Referral
growsurf_trigger_referralAwards referral credit to a referred participant after signup and a qualifying action in a campaign. Optionally delay the credit 1-90 days to cover a refund window.
Instructions
Trigger referral credit for a referred participant (use when your trigger is Sign up + Qualifying Action). Optionally pass delayInDays (1-90) to hold the credit for N days before awarding it (e.g. to cover a refund window). Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignId | Yes | Target program (campaign) id for this call. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server. | |
| delayInDays | No | ||
| participantId | No | ||
| participantEmail | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message | No | Human-readable result message. Present when credit was not awarded immediately. | |
| success | No | Whether referral credit was awarded, scheduled, or cancelled. |