---
title: "How to create a product review using Flowbox's API "
url: "https://kb.getflowbox.com/en/article/how-to-create-a-product-review-using-flowboxs-api"
language: "en"
last_updated: "2026-06-03T12:52:27.507Z"
---

# How to create a product review using Flowbox's API 

This guide will walk you through the process of retrieving your company data using Flowbox's API.

## Prerequisites

Before you start, ensure you have the following:

-   **API key**: Your unique API authentication key. If you don't have it yet, please contact your CSM and they'll provide it to you.

## API Endpoint

To retrieve the list of flows in your Flowbox account, you need to send a POST request to the following endpoint:

```
https://external-api.getflowbox.com/v2/reviews/create
```

> You can find more information and make test calls in our [Swaggerhub page](https://app.swaggerhub.com/apis-docs/FlowboxAB/External-API/v2#/External%20API/CreateProductReview).

## Required Parameters

| **Parameter** | **Type** | **Location** | **Description** |
| --- | --- | --- | --- |
| `api-key` | string | header | Your API authentication key. Must be included in every request. |
| `product_id` | string | body | The ID of the product being reviewed. Must match the ID in your catalog. |
| `title` | string | body | Title of the review. |
| `description` | string | body | Main text of the review. |
| `status` | string | body | Status of the review sent. One of: `auto_moderation_pending`, `published`, `pending`, `rejected`. |
| `stars` | integer | body | Integer between `0` and `5`. |
| `email` | string | body | Reviewer's email, must be valid. |
| `display_name` | string | body | Reviewer's display name. |
| `locale` | string | body | Locale code of the product being reviewed, will be used to set review language. |
| `source` | string | body | String to identify source, one of : `website`, `sequence`. |

## Optional Parameters

| **Parameter** | **Type** | **Location** | **Description** |
| --- | --- | --- | --- |
| `url` | string | body | URL of where the review is sent from |
| `is_email_verified` | boolean | body | Whether the email has been verified or not. |
| `sequence_id` | integer | body | Sequential integer identifier to deduplicate reviews on bulk import. |

## Example API Request

Here is an example request with both required and optional parameters:

```
curl -X 'POST' \  
'https://external-api.getflowbox.com/v2/reviews/create' \
  -H 'accept: application/json' \
  -H 'api-key: INSERT_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
  	"product_id": "INSERT_PRODUCT_ID_HERE",
  	"title": "TITLE_TEXT",
  	"description": "DESCRIPTION_TEXT",
  	"status": "auto_moderation_pending",
  	"stars": 5,
  	"email": "EMAIL@EXAMPLE.COM",
  	"display_name": "REVIEWER_NAME",
  	"locale": "en-EU",
  	"source": "website",
  	"url": "https://EXAMPLE.COM",
  	"is_email_verified": true
}'
```

### **Response:**

The response will be a simple JSON response indicating the status of the request.

### **JSON returned:**

| **Field** | **Type** | **Description** |
| --- | --- | --- |
| `status` | string | Request status. One of:`"success"`,`"error"`. |
| `data` | string | If successful, will return `"Review REVIEW_ID created successfully."` , otherwise will display an error message, e.g `"Bad Request"`. |