MCPMCP Tools/Review Invites/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.

Parameters
namestringoptional
The campaign's display name.
clientIdstringoptional
The client this campaign belongs to.
locationIdstringrequired
The location this campaign sends invites for.
campaignTypestringoptional
The channel mix, e.g. "email", "sms", "email_sms".
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.
status"draft" | "launched" | "stopped" | "archived"optional
Campaign status. Prefer run_campaign_action to change status through its lifecycle actions instead of setting this directly.
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.
emailBodyobjectoptional
The email body, as the rich-text JSON the campaign builder's editor produces.
emailHtmlstringoptional
Rendered HTML fallback of the email body.
smsBodystringoptional
The SMS message text.
smsReviewSitestringoptional
Which review site the SMS link points to.
reviewSitesobjectoptional
The review site(s) offered to happy customers, as the builder's JSON shape.
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.
followupsobjectoptional
Follow-up reminder schedule, as the builder's JSON shape.
stopFollowupOnClickbooleanoptional
Stop sending follow-ups once the recipient clicks through.
scheduleAtstringoptional
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 presentation style, as the builder's JSON shape.
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.
ratingMechanismobjectoptional
The star/rating widget configuration, as the builder's JSON shape.
askNamebooleanoptional
Ask the respondent for their name.
askFeedbackbooleanoptional
Ask the respondent for free-text feedback.
Example request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_review_campaign",
    "arguments": {
      "locationId": "string"
    }
  }
}
Example response
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "..."
      }
    ]
  }
}

Response shape shown for illustration — the actual content depends on the tool and your data.