growsurf_get_campaign_options
Retrieve the full Options tab configuration for a GrowSurf program to review referral triggers, anti-fraud settings, affiliate enrollment, and notifications before updating.
Instructions
Fetch the Options tab configuration for your GrowSurf program (referral triggers, anti-fraud lists and toggles, affiliate enrollment and application review, notifications, and other behavior options). Returns the full object with every field and its current value, the same shape you send back on update. autoFulfillRewards: false permits manual fulfillment and does not prove that any reward went undelivered. 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 |
|---|---|---|---|
| fraud | No | Anti-fraud settings: `blockedEmails`/`blockedIps`/`blockedCountries` and matching allow lists, `blockBurnerEmails`, `blockDataCenterIps`, `blockHighRiskReferrers`, `autoBlockHighRiskIps`, per-IP signup rate limits, and `recaptcha`. | |
| autoBlockFraud | No | Automatically block signups flagged as high fraud risk. | |
| rewardEvidence | No | What this response establishes about rewards. Combine with other reads; unknown here does not override evidence elsewhere. | |
| payoutThreshold | No | Affiliate programs only. Minimum payout in minor currency units (e.g. cents). `0` or `null` means no minimum. | |
| taxDocumentation | No | Affiliate programs only. Company billing details (name, address, VAT number) used on affiliate payout invoices and for VAT handling. | |
| autoFulfillRewards | No | Referral programs only. Automatically mark earned rewards as fulfilled. `false` permits manual fulfillment and does not establish a delivery failure. | |
| notificationEmails | No | Owner notification settings: `recipients` plus per-event `events` toggles. | |
| blockPaidAdsTraffic | No | Do not attribute referrals from visitors who arrived through paid ads. | |
| enforceGdprCompliance | No | Store only the minimum participant data (no IP addresses, fingerprints, or mobile instance ids). | |
| requireParticipantAuth | No | Require returning participants to authenticate. Affiliate programs require `true`. | |
| affiliateApplicationMode | No | Affiliate programs only. How public signups join the program. `OPEN_ENROLLMENT` enrolls them directly; `MANUAL_REVIEW` collects an application you approve or deny; `AUTO_APPROVE` collects the application and approves it immediately. A reviewed mode requires the program's published application page. Enrollment through the API, CSV import, dashboard, or invites is never blocked by this setting. | |
| referralCookieWindowDays | No | How long a referral-link click is remembered in the visitor's browser, in days. | |
| referralCreditWindowDays | No | How long a referred friend has to complete the qualifying action, in days. `null` means the credit never expires. | |
| requireManualFraudApproval | No | Flag suspected fraud for review instead of blocking signups automatically. | |
| requireManualRewardApproval | No | Referral programs only. Hold each earned reward for manual approval before it unlocks. | |
| affiliateReapplicationPolicy | No | Affiliate programs only. Whether a denied applicant may apply again. `AFTER_COOLDOWN` (the default) allows a new application once `affiliateReapplicationCooldownDays` has passed; `DISABLED` never allows one. | |
| affiliateReapplicationCooldownDays | No | Affiliate programs only. How many days a denied applicant waits before they can apply again (1-365, default 30). Only used when `affiliateReapplicationPolicy` is `AFTER_COOLDOWN`. | |
| affiliateApplicationReviewEstimateBusinessDays | No | Affiliate programs only. Optional review-time expectation shown to pending applicants, in business days (1-60). `null` clears it. |