Get Program Emails
growsurf_get_campaign_emailsFetch the Emails tab configuration for a GrowSurf campaign, including participant and admin email templates, sender settings, and read-only fields.
Instructions
Fetch the Emails tab configuration for your GrowSurf program, including participant and admin email templates, settings, and read-only fields. settings.sender.fromEmail is read-only and can be changed in the dashboard after domain verification. Sender fields can be null before configuration. When updating, omit unchanged sender fields; fromName and replyToEmail cannot be cleared with null. Targets campaignId if supplied, 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. |
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. Its read-only `layoutMode` is `INLINE` for new programs: bodies require `{{emailFooter}}` and may include `{{emailHeader}}`. Older programs omit `layoutMode` and keep their existing layout. | |
| 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. | |
| offerClaimed | No | Sent when a referred visitor saves an offer through the Claim Offer Popup. Referral and affiliate programs. Promotional; its toggle can be changed. | |
| 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. | |
| followUpReminder | No | Optional reminder to the referrer about directly invited contacts who have not signed up after `delayDays` (integer 2–30, default 3). Existing reminder dates stay unchanged. Disabled by default. Only new invitations created while this email is enabled qualify automatically. A later offer claim preserves invitation eligibility; popup-only claims never qualify. Each contact is included once. Referral and affiliate programs. | |
| 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. |