growsurf_get_campaign_emails
Fetch the email tab configuration for a GrowSurf program, including participant and admin templates and settings, using a campaign ID or the default campaign.
Instructions
Fetch the Emails tab configuration for your GrowSurf program (participant and admin email templates and settings). Returns the full object with every field and its current value — the same shape you send back on update. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignId | No | Target program (campaign) id for this call. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Pass the `id` returned by growsurf_create_campaign to configure or operate a program you just created, without restarting the server. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| invite | No | The invitation email a participant sends to friends. `useCompanyReplyTo` sets who receives replies. | |
| settings | No | Sender (`sender`), physical contact address (`contact`), and shared design (`design`) settings. The design object includes `unsubscribeAffiliateInvite` for direct affiliate invitation emails. | |
| loginLink | No | One-time sign-in link for returning participants. Transactional; its toggle cannot be changed. | |
| goalAchieved | No | Sent when a participant unlocks a reward. Referral programs only. | |
| payoutPending | No | Sent when a payout is on the way. Affiliate programs only. | |
| referredSignup | No | Sent to a referrer each time someone signs up using their link. Referral and affiliate programs. | |
| taxInfoMissing | No | Asks a participant to submit required tax information. Transactional; its toggle cannot be changed. | |
| inviteAffiliate | No | Invites a prospective affiliate to join the program. Its body must keep `{{affiliateInviteLink}}`. Affiliate programs only. Promotional; its toggle can be changed. | |
| taxInfoApproved | No | Tells a participant their tax form is complete and approved. Transactional; its toggle cannot be changed. | |
| taxInfoReceived | No | Confirms submitted tax information was received. Transactional; its toggle cannot be changed. | |
| taxInfoRejected | No | Tells a participant their tax information needs to be resubmitted. Transactional; its toggle cannot be changed. | |
| welcomeReferred | No | Welcome email for someone who signs up through a referral link. Referral programs only. | |
| referralLinkUsed | No | Sent to a referrer when they earn referral credit. Referral programs only. | |
| payoutSentSuccess | No | Sent when a payout completes. Affiliate programs only. | |
| commissionAdjusted | No | Sent when a commission is adjusted after a refund or chargeback. Affiliate programs only. | |
| welcomeNonReferred | No | Welcome email for a participant who joins without being referred. Referral and affiliate programs. | |
| commissionGenerated | No | Sent to an affiliate when they earn a new commission. Affiliate programs only. | |
| campaignEndedWinners | No | Sent to reward winners when the program ends. Referral programs only. | |
| progressUpdateMonthly | No | Month-end progress recap for participants. Referral and affiliate programs. | |
| campaignEndedNonWinners | No | Sent to non-winners when the program ends. Referral programs only. | |
| payoutDestinationChanged | No | Tells a participant their payout destination changed. Its body must keep `{{payoutDestinationMaskedEmail}}`. Referral and affiliate programs. Transactional; its toggle cannot be changed. | |
| affiliateApplicationDenied | No | Tells an applicant their affiliate application was not approved. Affiliate programs only. Transactional; its toggle cannot be changed. | |
| referralLinkViewedFirstTime | No | Sent the first time a participant's referral link is viewed. Referral and affiliate programs. | |
| affiliateApplicationApproved | No | Tells an applicant their affiliate application was approved. Affiliate programs only. Transactional; its toggle cannot be changed. | |
| affiliateApplicationReceived | No | Confirms an affiliate application was received and is under review. Affiliate programs only. Transactional; its toggle cannot be changed. | |
| payoutDestinationConfirmation | No | Asks a participant to confirm the payout destination where they will receive payouts, such as a PayPal or Wise email address. Its body may use `{{payoutProvider}}` and must keep `{{payoutDestinationConfirmationLink}}`. Referral and affiliate programs. Transactional; its toggle cannot be changed. | |
| affiliateApplicationStatusLink | No | Sends an applicant a secure link to view their application status. Its body must keep `{{applicationStatusLink}}`. Affiliate programs only. Transactional; its toggle cannot be changed. | |
| affiliateEmailChangeVerification | No | Asks an affiliate to confirm a new account email address. Its body must contain `{{identityVerificationLink}}`. Affiliate programs only. Transactional; its toggle cannot be changed. | |
| affiliateApplicationEmailCorrection | No | Asks an applicant to confirm a corrected email address. Its body must contain `{{identityVerificationLink}}`. Affiliate programs only. Transactional; its toggle cannot be changed. |