Send Review Invite

Send a review invite to a customer. We will handle the entire review collection process.

Use this API if you want CLOUTLY to handle the review collection process.

Sequence Diagram

POST /vendors/{vendorId}/send-review-invite

This will send a review invitation to the customer to review the supplier. The review invite will contain a link to a connected source such as "Google", "Facebook" and a fallback link which is a review using Cloutly.

Request

POST https://marketplace.cloutly.com/api/v2/vendors/{vendorId}/send-review-invite

{
  "sourceContactId": "id321", // optional - Your source contact ID.
  "campaignId": "id123", // customise branding/logos/messaging - obtained through campaign editor in Cloutly
  "firstName": "John",
  "lastName": "Smith",
  "channel": {
    "email": "[email protected]",
    "phoneNumber": "4412321321321"
  },
  "source": "my-platform",
  "inviteDelayHours": 24,
  "products": [
    {
      "sourceProductId": "12345", // Your source Product ID
      "title": "Peroni",
      "description": "A refreshing cold beer.",
      "imageUrl": "https://example.com/beer.png"
    }
  ]
}

Response

{
    "contact": {
        "id": "4a30cd9f-9b0e-486c-a9f8-55c1ee041471",
        "sourceContactId": "your_source_ref_id" // if provided
        ...
    },
}

Notes:

• Sms and email invites are charged differently. Contact us to learn more.

• campaignId is a static string. This value can be determined when configuring the email templates/messaging/branding you wish to use within the Cloutly Dashboard. Leave blank if you want to use the default template (non-branded).

• Phone number must include international country code. "+61" for Australia, "+1" for US etc.

• Optional: Store the contact.id if you want to edit/view this contact later.

If you have any questions regarding the REST API, feel free to chat with us at any time.