Get Program Design
growsurf_get_campaign_designRead-onlyIdempotent
Fetch configured design fields for a GrowSurf program, including colors, content, widget, and participant settings, to inspect or customize its appearance.
Instructions
Fetch the configured design fields for your GrowSurf program, including GrowSurf Window content, colors, sharing sections, participant avatars under participantAvatarStyle, referred-visitor content such as the Claim Offer Popup, the website widget under widget, the participant Traffic report under trafficInsights (it starts on for new affiliate programs and hidden for referral programs, and every setting is returned with its default copy), participant sign-in copy under login, payout-destination confirmation page copy under payoutDestinationConfirmation, country-name overrides under countryLabels, and the participant Settings panel under participantSettings (its languageSectionTitle and languageSectionInstructionsText label the language picker shown when the program has more than one language). participantAvatarStyle is CHARACTERS, INITIALS, ANIMALS, or GRADIENT; missing or unknown values mean INITIALS. visualStyle is the program Style (GLOW, CLEAN, FLAT, ROUND, TINT, or GLASS) and is omitted when the program has no saved Style. The confirmation section is omitted when no confirmation fields are stored. Stored null fields are returned as null; omitted and null fields use localized defaults. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"campaignId": "<campaignId>"
},
"name": "growsurf_get_campaign_design"
}
}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 |
|---|---|---|---|
| login | No | The returning-participant sign-in form plus its success, resend, validation, and error text. | |
| share | No | Share channels, invite settings, and share-button styling. | |
| stats | No | The participant's referral-progress stats panel. Only `title` is editable. | |
| theme | No | Visual theme styling (colors, shadows, and similar). | |
| header | No | Header content for participants (`postText`) and non-participants (`preText`), and the progress labels beside a participant's numbers: `referralsMadeText` (up to 100 characters, shown for single-sided, double-sided, and milestone rewards) and `yourRankText` (up to 100 characters, shown for leaderboard rewards). Both labels are required. | |
| signup | No | Signup form fields, GDPR consent, and button and login text. | |
| widget | No | The website widget — the invite that sits in a corner of the customer's own site. It renders as a button or as a card, and its card folds back into the button when a visitor closes it. Both audience switches start off, so a program shows nothing until one is turned on. | |
| window | No | Layout of the GrowSurf window (`navigationMode`: `TABS` or `LIST`). | |
| payouts | No | Affiliate programs only. The Payouts section of the participant portal. | |
| rewards | No | Heading, icon, and empty-state text of the rewards panel. | |
| resources | No | Participant Resources presentation settings: visibility, title, link and copy labels, the message shown when nothing is published, the section icon, and `emptyStateGraphic` (`type`: `DEFAULT`, `IMAGE`, or `NONE`; starter `key`; `imageUrl`). Resource items use the program Resource tools. | |
| commissions | No | Affiliate programs only. The Commissions section of the participant portal. | |
| leaderboard | No | The leaderboard section: labels, selectors, and name masking. | |
| visualStyle | No | The program Style. It sets corners, shadows, button shape and background on program pages and the GrowSurf Window. New referral programs start with `GLOW`, and new affiliate programs start with `CLEAN`. Omitted when the program has no saved Style; those programs keep their original look. | |
| landingPages | No | Portal and landing pages: company info, `content`, `styles`, third-party script ids, and SEO meta tags. `content.howItWorksTitle` is the plain-text heading above the How it works steps (up to 255 characters). The Program Page shows it, and the GrowSurf window shows it while `content.howItWorks` is still the starter heading `<h5>How It Works</h5>`. Programs that never set it read back `How it works`; send `null` or blank text to show `How it works` again. `content.howItWorksSteps` replaces the full ordered step array. Each step supports `text`, an optional bold `title`, `imageUrl`, and `iconKey`; `NUMBER` shows the current step number, while keys such as `SHARE` and `REWARD` show starter icons. `isProgramPageEnabled` turns on the Program Page for a referral program. After you turn it on, you cannot turn it off. `programPage` holds the Program Page content: `hero` (including `headlineAccent`, a phrase in the headline to highlight; `headlineAccentStyle`, `SOLID` or `GRADIENT`; and `headlineAccentColor`, a six-digit hex color used by `SOLID`), `blocks`, `sectionOrder`, `sectionVisibility` (`false` hides a section), `headerLinks` (referral programs only, up to 3), `howItWorks` (referral programs only), `applicationForm.fields` (affiliate programs only, 1 to 30 fields), `requirements`, and `messages`. `howItWorks` sets the style of the How it works card. `layout` is `scrim` (photo across the top of the card, title on the photo), `titleAbove` (title above the card, no photo), `none` (title inside the card, no photo), or `imageAbove` (title above the card, photo across the top of the card). `imageUrl` is an `https` photo URL or `null`; without a photo, `scrim` and `imageAbove` show as `titleAbove`. `scrimColor` is the fade color behind the title: `brand`, `brandDeeper`, or `brandDeepest` (shades of `theme.buttons.backgroundColor` that follow later color changes), `black`, or a `#RRGGBB` hex color. `null` saves `brand`. `scrimStrength` (`30` to `100`, default `100`) sets how far up the photo the fade reaches; the fade right behind the title stays strong. A program with no card has no `howItWorks` object, and its first `howItWorks` update must include `layout`. Updates get the same checks as a dashboard save. An array replaces the stored array. Blank `messages` text reads back as the default text. | |
| countryLabels | No | Participant-facing country-name overrides keyed by ISO 3166-1 alpha-2 code (for example `GB`). Each label replaces the default country name wherever participants pick a country, such as payout and tax forms. Overrides merge per code on `PATCH`; `null` (or the default name) restores a code's default. Only overridden codes are returned. | |
| referralStatus | No | The section listing who a participant invited and each invite's progress. `revealInviteEmails` lets a signed-in participant see original invitation addresses when disclosure permission was recorded. Private invites and full email masking keep addresses hidden. Other referral addresses stay masked. `revealInviteEmailText` supplies the sign-in prompt; `loadErrorMessage` is shown when the list cannot load; `followUp` supplies the invitation follow-up labels and messages. `statusTooltip` sets the tooltip text for each referral status. `sortFilter` controls the sort and filter menu: `isEnabled` shows or hides it, and the other fields set its labels and options. | |
| referralSummary | No | Referral programs only. The participant's row of summary tiles (clicks, leads, referrals, rewards). `stats.rewardsEarned.displayMode` selects `COUNT` (approved reward count) or `AMOUNT` (total of the approved rewards’ saved recipient amounts, using `referredRewardAmount` for a friend when present and otherwise `rewardAmount`, with saved currency matching the program currency). Telehealth programs default to `AMOUNT`; other referral programs default to `COUNT`. An explicit choice overrides the default. If any approved reward lacks a valid saved amount or matching currency, the participant sees the reward count. Changing a Campaign Reward's amount affects future rewards only. | |
| trafficInsights | No | The Traffic report participants can open from the GrowSurf window: visits to their share link over time and where those visits came from. It starts on for new affiliate programs and hidden for referral programs. Every setting is returned, with the default copy for anything not changed. Labels cannot be blank. | |
| affiliateSummary | No | Affiliate programs only. The affiliate's row of summary tiles (clicks, revenue, payouts). | |
| referredExperience | No | The banner, headline, and Claim Offer Popup shown to a visitor who arrives through a referral link. The popup is available for referral and affiliate programs. | |
| participantSettings | No | The participant's account settings area (logout, language picker, PayPal and Wise payout confirmation/status messages, tax details). `languageSectionTitle` (up to 100 characters) and `languageSectionInstructionsText` (up to 255 characters) are the title and help text of the language row, shown when the program has more than one language. `taxSection.instructionsText` and `taxSection.residencyLabel` show when tax forms are required; `taxSection.vatOnlyInstructionsText` and `taxSection.vatOnlyResidencyLabel` show instead when an affiliate program collects VAT numbers without requiring tax forms. | |
| participantAvatarStyle | No | How participant avatars appear in the GrowSurf Window. New programs start with `INITIALS`. Programs with a missing or unknown stored value return `INITIALS` for backward compatibility. | |
| payoutDestinationConfirmation | No | Customizable text for the payout-destination confirmation page opened from payout integration cards. One shared set applies to every enabled payout provider. Provider-aware text may use `{{payoutProvider}}`; omitted and `null` fields use localized defaults. |