MCPOutils MCP/Invitations à laisser un avis/create_review_campaign
create_review_campaign
Writereview-invite:write
Create a new review-invite (acquisition) campaign — an email/SMS flow that asks customers to leave a review, screens them by rating, and routes happy customers to a public review site. Created as a draft; use run_campaign_action with op "publish" to launch it once configured. locationId is required; everything else can be filled in now or with update_review_campaign later. Returns the created campaign. You don't pass an agency — it comes from your credentials.
Paramètres
namestringfacultatif
The campaign's display name.
clientIdstringfacultatif
The client this campaign belongs to.
locationIdstringobligatoire
The location this campaign sends invites for.
campaignTypestringfacultatif
The channel mix, e.g. "email", "sms", "email_sms".
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.
status"draft" | "launched" | "stopped" | "archived"facultatif
Campaign status. Prefer run_campaign_action to change status through its lifecycle actions instead of setting this directly.
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.
emailBodyobjectfacultatif
The email body, as the rich-text JSON the campaign builder's editor produces.
emailHtmlstringfacultatif
Rendered HTML fallback of the email body.
smsBodystringfacultatif
The SMS message text.
smsReviewSitestringfacultatif
Which review site the SMS link points to.
reviewSitesobjectfacultatif
The review site(s) offered to happy customers, as the builder's JSON shape.
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.
followupsobjectfacultatif
Follow-up reminder schedule, as the builder's JSON shape.
stopFollowupOnClickbooleanfacultatif
Stop sending follow-ups once the recipient clicks through.
scheduleAtstringfacultatif
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 presentation style, as the builder's JSON shape.
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.
ratingMechanismobjectfacultatif
The star/rating widget configuration, as the builder's JSON shape.
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": "create_review_campaign",
"arguments": {
"locationId": "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.