Send a Review Invite via API

Add a customer to a review-invite campaign with the Synup API once a visit completes, and the domain and number verification that gating requires.

En bref

Ce que ce guide permet

Add a customer to a published review campaign so Synup sends them an invite by email or SMS.

API utilisées

post/api/v1/review-invitesAjouter des destinataires à une campagne
post/api/v1/review-invites/campaignsCréer une campagne
post/api/v1/review-invites/campaigns/{id}/actionExécuter une action de cycle de vie sur une campagne

Référence

Invitations à laisser un avis

Prérequis

An API key with write access
A published campaign, on a client with a verified domain or number

Cas d'usage typiques

Triggering an invite from a point-of-sale or booking webhook
Asking for a review after a completed visit
Feeding recipients from your own CRM

Sending an invite is really adding a recipient to a campaign that is already running. POST /api/v1/review-invites takes a campaign id and a batch of people, and Synup sends each one the invite over the campaign's channel. The call you make from a booking or point-of-sale webhook is just this one.

curl -X POST https://ai.synup.com/api/v1/review-invites \
  -H "Authorization: Bearer $SYNUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "CAMPAIGN_ID",
    "recipients": [
      { "name": "Jordan Lee", "email": "jordan@example.com", "phone": "+14155550123", "contactType": "Customer" }
    ],
    "smsConsent": { "by": "front-desk@grovestreetdental.example" }
  }'

Recipients are deduplicated within the batch and against the campaign, and the response counts what was actually added versus what was already there. That means you can safely retry a webhook without sending someone two invites.

The campaign has to exist and be published first, and that is a one-time setup, not something you do per invite. POST /api/v1/review-invites/campaigns makes the draft and POST /api/v1/review-invites/campaigns/{id}/action with op: "publish" launches it.

Invites are one half of a review programme. Replying to what comes back is the other. See respond to a review, and the reputation platform guide for campaigns, screening and widgets end to end.