---
description: >-
  Post review data to Cloutly. This helps drive more Google/Facebook reviews for
  your suppliers.
---

# Submit Review

{% hint style="info" %}
Use this API if you want **YOUR SYSTEM** to handle the review collection process, and submit the data directly to Cloutly.
{% endhint %}

## Sequence Diagram

<figure><img src="https://3306390908-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN3eb7kynf7Kr1Tnxpdrm%2Fuploads%2FSKmP3aKjP9HlC2CfyVhI%2FScreenshot%202024-10-29%20at%2014.49.39.png?alt=media&#x26;token=b3aea74d-5288-4b32-bbd0-f774b975b645" alt=""><figcaption></figcaption></figure>



## POST /vendors/{vendorId}/submit-review

This will add review data for a vendor. The review data will be used in the insights engine and available on review widgets.

* Please remember to add the `Product` details if this was for a product review.

### Request

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

{
  "rating": "5", // 1-5 string
  "text": "This product is awesome!",
  "vendorId": "<vendor_id_created_in_first_step>",
  "firstName": "John",
  "lastName": "Smith",
  "channel": {
    "email": "useremail@gmail.com",
    "phoneNumber": "4412321321321"
  },
  "source": "my-platform",
  "product": {
      "sourceProductId": "12345",
      "title": "Peroni",
      "description": "A refreshing cold beer.",
      "imageUrl": "https://example.com/beer.png"
  },
  "showOnWidget": true, // flag to hide reviews from review widgets.
}
```

### Response

```
{
    "feedback": {
        "id": "4a30cd9f-9b0e-486c-a9f8-55c1ee041471",
        "source": "my-platform" // if provided
        ...
    },
}
```

## Notes:

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