MCPOutils MCP/Invitations à laisser un avis/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.
Paramètres
campaignIdstringobligatoire
The id of the campaign to update (required).
namestringfacultatif
The campaign's display name.
clientIdstringfacultatif
The client this campaign belongs to. Accepts the database ID or public cli- ID. IDs must belong to the authenticated agency and permitted client.
locationIdstringfacultatif
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"facultatif
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"facultatif
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.
fromEmailstringfacultatif
The sending "from" email address (requires a verified sending domain to actually send).
replyToEmailstringfacultatif
The reply-to email address.
emailSubjectstringfacultatif
The email's subject line.
emailBodyfacultatif
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.
emailHtmlstringfacultatif
The HTML that is actually sent for email campaigns, with merge tags such as {{firstName}} and {{reviewSiteLink}}.
smsBodystringfacultatif
The SMS message text.
smsReviewSitestringfacultatif
Which review site the SMS link points to.
reviewSitesobject[]facultatif
The review site(s) offered to happy customers, e.g. [{ "name": "Google", "url": "https://g.page/r/…" }].
namestringfacultatif
Display name, e.g. "Google".
urlstringfacultatif
The http(s) review link.
idstringfacultatif
Stable id; derived from the name when omitted.
checkedbooleanfacultatif
Whether this site is offered (default true).
custombooleanfacultatif
True for a site you added yourself rather than a built-in one.
screeningEnabledbooleanfacultatif
Whether to screen customers by star rating before directing them to a public review site.
landingTitlestringfacultatif
Title shown on the campaign's landing/funnel page.
landingContentstringfacultatif
Body content shown on the campaign's landing/funnel page.
hideAddressbooleanfacultatif
Hide the business address on the landing page.
hideBusinessNamebooleanfacultatif
Hide the business name on the landing page.
hideImagebooleanfacultatif
Hide the business image on the landing page.
followupsobject[]facultatif
Follow-up reminder schedule, e.g. [{ "key": "first", "enabled": true, "subject": "Quick reminder", "delayValue": 3, "delayUnit": "days" }].
key"first" | "second" | "unlimited"facultatif
first and second are one-off reminders; unlimited repeats.
enabledbooleanfacultatif
Whether this follow-up sends.
subjectstringfacultatif
Follow-up email subject.
delayValuenumberfacultatif
How long after the previous send (the repeat interval for unlimited). Must be > 0.
delayUnit"days" | "hours"facultatif
Unit for delayValue.
stopFollowupOnClickbooleanfacultatif
Stop sending follow-ups once the recipient clicks through.
scheduleAtfacultatif
ISO datetime to schedule the campaign launch for. Pass null/empty to send immediately on publish.
timezonestringfacultatif
IANA timezone for scheduling, e.g. "America/New_York".
autoSendbooleanfacultatif
Whether new recipients are sent to automatically once the campaign is launched. Can also be toggled with run_campaign_action's autoSend op.
staticUrlstringfacultatif
A static/QR review-request URL slug for this campaign, if used instead of (or alongside) email/SMS sends.
thankYouEnabledbooleanfacultatif
Whether to show a thank-you follow-up after a positive review.
thankYouSubjectstringfacultatif
Thank-you email subject.
thankYouBodystringfacultatif
Thank-you email body.
thankYouDelayHoursnumberfacultatif
Hours to wait before sending the thank-you follow-up.
funnelThresholdnumberfacultatif
Star-rating threshold that routes a respondent to the public review site vs. private feedback.
funnelStyleobjectfacultatif
Funnel page styling.
bgColorstringfacultatif
Background colour, e.g. #ffffff.
starColorstringfacultatif
Star colour.
textColorstringfacultatif
Text colour.
logoUrlstringfacultatif
Logo image URL.
lowRankContentstringfacultatif
Content shown to respondents who rate below funnelThreshold.
hideFeedbackBoxbooleanfacultatif
Hide the free-text feedback box on the landing page.
collectMode"directory" | "internal"facultatif
How feedback is collected on the landing page.
ratingMechanismfacultatif
Omit/null for 1-5 stars, or a two-option widget: { type: "two_option", positive: { icon, label }, negative: { icon, label } }.
askNamebooleanfacultatif
Ask the respondent for their name.
askFeedbackbooleanfacultatif
Ask the respondent for free-text feedback.
Exemple de requête
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_review_campaign",
"arguments": {
"campaignId": "string"
}
}
}Exemple de réponse
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"content": [
{
"type": "text",
"text": "..."
}
]
}
}La forme de la réponse est indicative — le contenu réel dépend de l'outil et de vos données.