MCPMCP-Tools/Bewertungseinladungen/update_review_campaign
update_review_campaign
Writereview-invite:write
Edit an existing review-invite campaign's configuration. Pass only the fields you want to change. Identify the campaign by its id (from list_review_campaigns or create_review_campaign). To change the campaign's lifecycle status (publish/stop/clone/archive) use run_campaign_action instead of setting `status` directly here. Returns the updated campaign, or throws if not found.
Parameter
campaignIdstringerforderlich
The id of the campaign to update (required).
namestringoptional
The campaign's display name.
clientIdstringoptional
The client this campaign belongs to. Accepts the database ID or public cli- ID. IDs must belong to the authenticated agency and permitted client.
locationIdstringoptional
The location this campaign sends invites for. Accepts the database ID or public loc- ID. IDs must belong to the authenticated agency and permitted client.
campaignType"email_sms" | "review_funnel"optional
What kind of campaign: "email_sms" (default) sends to a recipient list on the channels set in `channels`; "review_funnel" is a shareable link / QR page that sends nothing. Email vs SMS is NOT a type — use `channels` for that.
channels"EMAIL" | "SMS" | "SMS_AND_EMAIL"optional
Which channels the campaign sends on. Anything other than these three is stored as "EMAIL". Email requirements (fromEmail, a verified sending domain) only apply when EMAIL is included; an SMS-only campaign instead needs a carrier-verified number for its location.
fromEmailstringoptional
The sending "from" email address (requires a verified sending domain to actually send).
replyToEmailstringoptional
The reply-to email address.
emailSubjectstringoptional
The email's subject line.
emailBodyoptional
The campaign builder's editor template ({ blocks: [...], body: {...} }), kept so the campaign stays editable in the builder. It is NOT what gets sent — set `emailHtml` (HTML with merge tags {{firstName}} {{lastName}} {{businessName}} {{locationName}} {{locationAddress}} {{reviewSiteLink}}) to send custom content. Pass null to clear.
emailHtmlstringoptional
The HTML that is actually sent for email campaigns, with merge tags such as {{firstName}} and {{reviewSiteLink}}.
smsBodystringoptional
The SMS message text.
smsReviewSitestringoptional
Which review site the SMS link points to.
reviewSitesobject[]optional
The review site(s) offered to happy customers, e.g. [{ "name": "Google", "url": "https://g.page/r/…" }].
namestringoptional
Display name, e.g. "Google".
urlstringoptional
The http(s) review link.
idstringoptional
Stable id; derived from the name when omitted.
checkedbooleanoptional
Whether this site is offered (default true).
custombooleanoptional
True for a site you added yourself rather than a built-in one.
screeningEnabledbooleanoptional
Whether to screen customers by star rating before directing them to a public review site.
landingTitlestringoptional
Title shown on the campaign's landing/funnel page.
landingContentstringoptional
Body content shown on the campaign's landing/funnel page.
hideAddressbooleanoptional
Hide the business address on the landing page.
hideBusinessNamebooleanoptional
Hide the business name on the landing page.
hideImagebooleanoptional
Hide the business image on the landing page.
followupsobject[]optional
Follow-up reminder schedule, e.g. [{ "key": "first", "enabled": true, "subject": "Quick reminder", "delayValue": 3, "delayUnit": "days" }].
key"first" | "second" | "unlimited"optional
first and second are one-off reminders; unlimited repeats.
enabledbooleanoptional
Whether this follow-up sends.
subjectstringoptional
Follow-up email subject.
delayValuenumberoptional
How long after the previous send (the repeat interval for unlimited). Must be > 0.
delayUnit"days" | "hours"optional
Unit for delayValue.
stopFollowupOnClickbooleanoptional
Stop sending follow-ups once the recipient clicks through.
scheduleAtoptional
ISO datetime to schedule the campaign launch for. Pass null/empty to send immediately on publish.
timezonestringoptional
IANA timezone for scheduling, e.g. "America/New_York".
autoSendbooleanoptional
Whether new recipients are sent to automatically once the campaign is launched. Can also be toggled with run_campaign_action's autoSend op.
staticUrlstringoptional
A static/QR review-request URL slug for this campaign, if used instead of (or alongside) email/SMS sends.
thankYouEnabledbooleanoptional
Whether to show a thank-you follow-up after a positive review.
thankYouSubjectstringoptional
Thank-you email subject.
thankYouBodystringoptional
Thank-you email body.
thankYouDelayHoursnumberoptional
Hours to wait before sending the thank-you follow-up.
funnelThresholdnumberoptional
Star-rating threshold that routes a respondent to the public review site vs. private feedback.
funnelStyleobjectoptional
Funnel page styling.
bgColorstringoptional
Background colour, e.g. #ffffff.
starColorstringoptional
Star colour.
textColorstringoptional
Text colour.
logoUrlstringoptional
Logo image URL.
lowRankContentstringoptional
Content shown to respondents who rate below funnelThreshold.
hideFeedbackBoxbooleanoptional
Hide the free-text feedback box on the landing page.
collectMode"directory" | "internal"optional
How feedback is collected on the landing page.
ratingMechanismoptional
Omit/null for 1-5 stars, or a two-option widget: { type: "two_option", positive: { icon, label }, negative: { icon, label } }.
askNamebooleanoptional
Ask the respondent for their name.
askFeedbackbooleanoptional
Ask the respondent for free-text feedback.
Beispielanfrage
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_review_campaign",
"arguments": {
"campaignId": "string"
}
}
}Beispielantwort
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"content": [
{
"type": "text",
"text": "..."
}
]
}
}Die Antwortform dient nur zur Veranschaulichung — der tatsächliche Inhalt hängt vom Tool und Ihren Daten ab.