growsurf_update_campaign_reward
Update an existing campaign reward configuration in GrowSurf, adjusting titles, values, limits, or commission structures to keep your referral program aligned with current goals.
Instructions
Update an existing campaign reward (reward config) on your GrowSurf program. campaignRewardId is the reward key (e.g. crew_...). The reward type is immutable. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| order | No | ||
| title | No | ||
| value | No | Tax valuation for the reward (the referrer's side of a double-sided reward). `fairMarketValueUSD` is the manual fair-market value in USD (major units). `taxCharacter` is the reason the recipient earns the reward. For configurable non-commission rewards, `null` inherits the program's confirmed treatment. Commission rewards always use `NONEMPLOYEE_SERVICES`. | |
| imageUrl | No | ||
| metadata | No | ||
| isVisible | No | ||
| 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. | |
| couponCode | No | ||
| description | No | ||
| isUnlimited | No | ||
| limitDuration | No | ||
| referredValue | No | Tax valuation for the referred friend's side of a double-sided reward. `taxCharacter` is the reason the recipient earns the reward. For configurable non-commission rewards, `null` inherits the program's confirmed treatment. Commission rewards have no referred-friend side, so GrowSurf clears these settings. Use `PURCHASE_REBATE` only when that is the correct tax character. | |
| numberOfWinners | No | ||
| campaignRewardId | Yes | ||
| referralCouponCode | No | ||
| commissionStructure | No | Affiliate commission structure (AFFILIATE rewards only). Provide `amount` (+ optional `amountISO`) for a FIXED commission, or `percent` for a PERCENT commission. | |
| conversionsRequired | No | ||
| nextMilestonePrefix | No | ||
| nextMilestoneSuffix | No | ||
| referralDescription | No | ||
| referredRewardUpfront | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||