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.
locationIdstringobrigatório
The location this campaign sends invites for.
campaignTypestringopcional
The channel mix, e.g. "email", "sms", "email_sms".
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.
status"draft" | "launched" | "stopped" | "archived"opcional
Campaign status. Prefer run_campaign_action to change status through its lifecycle actions instead of setting this directly.
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.
emailBodyobjectopcional
The email body, as the rich-text JSON the campaign builder's editor produces.
emailHtmlstringopcional
Rendered HTML fallback of the email body.
smsBodystringopcional
The SMS message text.
smsReviewSitestringopcional
Which review site the SMS link points to.
reviewSitesobjectopcional
The review site(s) offered to happy customers, as the builder's JSON shape.
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.
followupsobjectopcional
Follow-up reminder schedule, as the builder's JSON shape.
stopFollowupOnClickbooleanopcional
Stop sending follow-ups once the recipient clicks through.
scheduleAtstringopcional
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 presentation style, as the builder's JSON shape.
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.
ratingMechanismobjectopcional
The star/rating widget configuration, as the builder's JSON shape.
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.