Synup
Ver conexões MCP
MCPFerramentas MCP/Convites de avaliação/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.

Parâmetros
namestringopcional
The campaign's display name.
clientIdstringopcional
The client this campaign belongs to. Accepts the database ID or public cli- ID. IDs must belong to the authenticated agency and permitted client.
locationIdstringobrigatório
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"opcional
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"opcional
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.
fromEmailstringopcional
The sending "from" email address (requires a verified sending domain to actually send).
replyToEmailstringopcional
The reply-to email address.
emailSubjectstringopcional
The email's subject line.
emailBodyopcional
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.
emailHtmlstringopcional
The HTML that is actually sent for email campaigns, with merge tags such as {{firstName}} and {{reviewSiteLink}}.
smsBodystringopcional
The SMS message text.
smsReviewSitestringopcional
Which review site the SMS link points to.
reviewSitesobject[]opcional
The review site(s) offered to happy customers, e.g. [{ "name": "Google", "url": "https://g.page/r/…" }].
namestringopcional
Display name, e.g. "Google".
urlstringopcional
The http(s) review link.
idstringopcional
Stable id; derived from the name when omitted.
checkedbooleanopcional
Whether this site is offered (default true).
custombooleanopcional
True for a site you added yourself rather than a built-in one.
screeningEnabledbooleanopcional
Whether to screen customers by star rating before directing them to a public review site.
landingTitlestringopcional
Title shown on the campaign's landing/funnel page.
landingContentstringopcional
Body content shown on the campaign's landing/funnel page.
hideAddressbooleanopcional
Hide the business address on the landing page.
hideBusinessNamebooleanopcional
Hide the business name on the landing page.
hideImagebooleanopcional
Hide the business image on the landing page.
followupsobject[]opcional
Follow-up reminder schedule, e.g. [{ "key": "first", "enabled": true, "subject": "Quick reminder", "delayValue": 3, "delayUnit": "days" }].
key"first" | "second" | "unlimited"opcional
first and second are one-off reminders; unlimited repeats.
enabledbooleanopcional
Whether this follow-up sends.
subjectstringopcional
Follow-up email subject.
delayValuenumberopcional
How long after the previous send (the repeat interval for unlimited). Must be > 0.
delayUnit"days" | "hours"opcional
Unit for delayValue.
stopFollowupOnClickbooleanopcional
Stop sending follow-ups once the recipient clicks through.
scheduleAtopcional
ISO datetime to schedule the campaign launch for. Pass null/empty to send immediately on publish.
timezonestringopcional
IANA timezone for scheduling, e.g. "America/New_York".
autoSendbooleanopcional
Whether new recipients are sent to automatically once the campaign is launched. Can also be toggled with run_campaign_action's autoSend op.
staticUrlstringopcional
A static/QR review-request URL slug for this campaign, if used instead of (or alongside) email/SMS sends.
thankYouEnabledbooleanopcional
Whether to show a thank-you follow-up after a positive review.
thankYouSubjectstringopcional
Thank-you email subject.
thankYouBodystringopcional
Thank-you email body.
thankYouDelayHoursnumberopcional
Hours to wait before sending the thank-you follow-up.
funnelThresholdnumberopcional
Star-rating threshold that routes a respondent to the public review site vs. private feedback.
funnelStyleobjectopcional
Funnel page styling.
bgColorstringopcional
Background colour, e.g. #ffffff.
starColorstringopcional
Star colour.
textColorstringopcional
Text colour.
logoUrlstringopcional
Logo image URL.
lowRankContentstringopcional
Content shown to respondents who rate below funnelThreshold.
hideFeedbackBoxbooleanopcional
Hide the free-text feedback box on the landing page.
collectMode"directory" | "internal"opcional
How feedback is collected on the landing page.
ratingMechanismopcional
Omit/null for 1-5 stars, or a two-option widget: { type: "two_option", positive: { icon, label }, negative: { icon, label } }.
askNamebooleanopcional
Ask the respondent for their name.
askFeedbackbooleanopcional
Ask the respondent for free-text feedback.
Exemplo de solicitação
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_review_campaign",
    "arguments": {
      "locationId": "string"
    }
  }
}
Exemplo de resposta
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "..."
      }
    ]
  }
}

O formato da resposta é ilustrativo — o conteúdo real depende da ferramenta e dos seus dados.