SynupMCP
View MCP connections
MCPMCP Tools/Review Invites

Review Invites

Create and manage review invite campaigns, templates, and recipients.

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.

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

Parameters
campaignIdstringrequired
The id of the campaign to update (required).
namestringoptional
The campaign's display name.
clientIdstringoptional
The client this campaign belongs to.
locationIdstringoptional
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": "update_review_campaign",
    "arguments": {
      "campaignId": "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.

MCPMCP Tools/Review Invites/run_campaign_action

run_campaign_action

Writereview-invite:write

Run a lifecycle action on a review-invite campaign. Actions: "publish" launches the campaign — if autoSend is on this starts sending real emails/SMS to recipients immediately, and it is gated per channel: a campaign whose channels include EMAIL requires a verified sending domain for the client, and one whose channels include SMS requires a carrier-verified number for the location (either failure returns an explanatory error); "stop" halts an active campaign; "clone" duplicates it as a new draft (returns the clone); "autoSend" turns automatic sending on/off for new recipients (pass `on`); "archive" archives it (only allowed once stopped — a still-active campaign is silently skipped, check the response); "unarchive" restores an archived campaign. Identify the campaign by its id.

Parameters
campaignIdstringrequired
The id of the campaign to act on (required, from list_review_campaigns).
op"publish" | "stop" | "clone" | "autoSend" | "archive" | "unarchive"required
The action to run (required).
onbooleanoptional
Required when op is "autoSend" — true to enable, false to disable.
Example request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "run_campaign_action",
    "arguments": {
      "campaignId": "string",
      "op": "publish"
    }
  }
}
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.

MCPMCP Tools/Review Invites/add_campaign_recipients

add_campaign_recipients

Writereview-invite:write

Add recipients to a review-invite campaign. Each recipient needs at least an email or phone. If the campaign is already launched with autoSend on (and sends both email and SMS), adding recipients here immediately triggers a real send to the new rows — not just a data insert. Returns the number of recipients added. Identify the campaign by its id (from list_review_campaigns or create_review_campaign).

Parameters
campaignIdstringrequired
The id of the campaign to add recipients to (required).
recipientsobject[]required
One or more recipients to add.
namestringoptional
Recipient's name.
emailstringoptional
Recipient's email address.
phonestringoptional
Recipient's phone number.
sourcestringoptional
Where this recipient came from, e.g. "manual", "csv", "pos".
contactTypestringoptional
Contact type, if tracked (e.g. "customer").
channelstringoptional
Preferred send channel for this recipient, e.g. "email" | "sms".
Example request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_campaign_recipients",
    "arguments": {
      "campaignId": "string",
      "recipients": [
        {}
      ]
    }
  }
}
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.

MCPMCP Tools/Review Invites/list_invite_templates

list_invite_templates

Readreview-invite:read

List the agency's saved review-invite message templates (reusable email/SMS content for campaigns). Use this to find a template's id before update_invite_template or delete_invite_template.

Example request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_invite_templates",
    "arguments": {}
  }
}
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.

MCPMCP Tools/Review Invites/create_invite_template

create_invite_template

Writereview-invite:write

Create a reusable review-invite message template. `content` is the rich-text JSON shape the campaign builder's editor produces (pass the same shape as an existing template's `content` if adapting one). Optionally assign it to specific locations so it shows as a suggested template there. Returns the created template.

Parameters
namestringrequired
The template's display name (required).
descriptionstringoptional
A short description of when to use this template.
contentobjectoptional
The template content, as the builder's rich-text JSON shape.
assignedLocationIdsstring[]optional
Location ids this template is suggested for. Omit to make it available agency-wide.
Example request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_invite_template",
    "arguments": {
      "name": "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.

MCPMCP Tools/Review Invites/update_invite_template

update_invite_template

Writereview-invite:write

Edit an existing review-invite template. Pass only the fields you want to change. Identify the template by its id (from list_invite_templates). Returns the updated template, or throws if not found.

Parameters
templateIdstringrequired
The id of the template to update (required).
namestringoptional
New display name.
descriptionstringoptional
New description.
contentobjectoptional
New content, as the builder's rich-text JSON shape.
assignedLocationIdsstring[]optional
Replaces the assigned location ids.
Example request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_invite_template",
    "arguments": {
      "templateId": "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.

MCPMCP Tools/Review Invites/delete_invite_template

delete_invite_template

Writereview-invite:write

Permanently delete a review-invite template. This does not affect campaigns already using its content — it only removes the reusable template. Identify the template by its id (from list_invite_templates).

Parameters
templateIdstringrequired
The id of the template to delete (required).
Example request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_invite_template",
    "arguments": {
      "templateId": "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.

MCPMCP Tools/Review Invites/find_campaign_recipients

find_campaign_recipients

Readreview-invite:read

Search the agency's review-invite recipients by name, email or phone, across every campaign, location and source (manual, CSV, CRM). Use this when you know who someone is but not which campaign or location they're in — unlike list_campaign_recipients, this needs no clientId or locationId. Returns matching contacts with their id, campaign, location, source, contact type, and whether they've already been messaged. The id is what update_campaign_recipient and move_campaign_recipients take.

Parameters
querystringrequired
Name, email address, or phone number to search for. Partial matches work; case-insensitive.
limitnumberoptional
How many to return (default 25, max 100).
Example request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "find_campaign_recipients",
    "arguments": {
      "query": "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.

MCPMCP Tools/Review Invites/update_campaign_recipient

update_campaign_recipient

Writereview-invite:write

Correct a review-invite recipient's details — name, email, phone or contact type. Pass only the fields you're changing. Identify the recipient by id (from find_campaign_recipients or list_campaign_recipients). Editing email or phone on a contact who has ALREADY been messaged is refused: the delivered message and any reply are tied to the address it went to, so changing it would misattribute them. Returns the updated contact.

Parameters
recipientIdstringrequired
The id of the recipient to update (required).
namestringoptional
Corrected name.
emailstringoptional
Corrected email address.
phonestringoptional
Corrected phone number.
contactType"Customer" | "Lead" | "Prospect" | "Contact"optional
Contact type.
Example request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_campaign_recipient",
    "arguments": {
      "recipientId": "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.

MCPMCP Tools/Review Invites/move_campaign_recipients

move_campaign_recipients

Writereview-invite:write

Move review-invite recipients to a campaign at a different location — the fix when an import filed contacts under the wrong branch. A recipient's location IS its campaign's location, so this takes a target campaignId; use list_review_campaigns to find campaigns at the location you want. Contacts that have already been messaged cannot be moved (the delivered message belongs to the location it was sent from), and moving pending contacts into a live auto-sending campaign is refused unless you pass allowSend:true, because it would message them immediately. Returns how many moved.

Parameters
recipientIdsstring[]required
Ids of the recipients to move (required).
campaignIdstringrequired
The campaign to move them into — this is what sets their location (required).
allowSendbooleanoptional
Set true to accept that a live auto-sending campaign will message these contacts on arrival. Defaults to false, which refuses that case.
Example request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "move_campaign_recipients",
    "arguments": {
      "recipientIds": [
        "string"
      ],
      "campaignId": "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.