Create Campaign Reward
growsurf_create_campaign_rewardCreates a new campaign reward configuration for a GrowSurf program, selecting a reward type compatible with referral or affiliate campaign rules.
Instructions
Create a new campaign reward (reward config) on your GrowSurf program. type must be compatible with the program type (affiliate programs support only AFFILIATE rewards; referral programs support the other types). 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": {
"type": "<type>",
"campaignId": "<campaignId>"
},
"name": "growsurf_create_campaign_reward"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | ||
| event | No | The referral event that earns this Campaign Reward. Use `LEAD` for a referred signup or `CONVERSION` for a qualifying action. A `LEAD` reward requires a later custom conversion trigger. Referral reward types only. | |
| 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 | Custom key/value metadata. Sending it replaces the stored object. Each value must be a string, number, or boolean of up to 500 characters. Each key must have 1 to 40 characters once camelCased, and two keys that camelCase to the same key are rejected. Up to 50 keys. An entry that breaks these rules returns `400`. For DOUBLE_SIDED referral rewards, `rewardAmount` is the referrer's amount and `referredRewardAmount` the friend's; without `referredRewardAmount` the friend uses `rewardAmount` unless `referralDescription` is a percent or free offer. Positive amounts use whole units for zero-decimal currencies and at most two decimals otherwise. | |
| isVisible | No | ||
| 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. | |
| couponCode | No | ||
| description | No | ||
| isUnlimited | No | ||
| imageIconKey | No | The starter icon shown for the reward, or `null` when `imageUrl` is your own image. Participant pages draw this icon in your program's accent color. Also set `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending `imageUrl` without `imageIconKey` clears it. | |
| 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 | ||
| referralCouponCode | No | ||
| commissionStructure | No | Affiliate commission structure (AFFILIATE rewards only). Provide a positive `amount` (+ optional `amountISO`) for a FIXED commission, or `percent` for a PERCENT commission. CLICK and LEAD commissions must use FIXED. | |
| conversionsRequired | No | ||
| nextMilestonePrefix | No | ||
| nextMilestoneSuffix | No | ||
| referralDescription | No | ||
| referredRewardUpfront | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||