Update Participant
growsurf_update_participantUpdate a GrowSurf participant by ID or email, changing only the fields you send. Manage names, email, language, notes, referrals, and affiliate status; read-only fields are rejected.
Instructions
Update a participant by GrowSurf participant ID or email. Only the fields you send are changed; read-only fields such as counters, isAffiliate, origin, and fraud state are rejected with a 400. In affiliate programs, affiliateStatus accepts APPROVED, SUSPENDED, or BANNED; APPROVED enrolls the participant, while SUSPENDED and BANNED require an existing affiliate. Affiliate enrollment cannot be removed through REST. notes is freeform internal notes (never shown to participants). Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Change the participant's email address. | ||
| notes | No | Freeform internal notes (internal only, never exposed to participants). | |
| language | No | The language of the participant's portal and program emails. Must be one of the program's languages (`languages` in `growsurf_get_campaign_options`); any other code returns a `400`. Send `null` or the program's base language to clear it, so the participant follows the base language. Supported codes: `en`, `es`, `fr`, `de`, `it`, `pt-BR`, `nl`, `pl`, `sv`, `tr`, `ja`, `ko`, `zh-CN`, `id`, `da`, `nb`, `nn`, `fi`, `is`, `cs`, `sk`, `hu`, `ro`, `hr`, `sl`, `et`, `lv`, `lt`, `el`, `bg`, `uk`, `ru`, `pt-PT`, `ca`, `vi`, `ms`, `fil`, `af`, `sw`. | |
| lastName | No | ||
| metadata | No | ||
| firstName | 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. | |
| referredBy | No | ||
| vanityKeys | No | ||
| unsubscribed | No | ||
| participantId | No | ||
| referralStatus | No | ||
| affiliateStatus | No | Affiliate programs only. Sets the affiliate status. `APPROVED` also enrolls a participant who is not yet an affiliate. `SUSPENDED` and `BANNED` are rejected for non-affiliates. | |
| participantEmail | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||