---
title: Reviews v4 API
description: In this documentation, you can find a description of the methods of the BrandWizard API in the Reviews v4 section.
---

[Skip to content](https://help.brandwizard.io/knowledge/reviews-v4-api#main-content)

English

Show submenu for translations

![logo2.png\]](https://help.brandwizard.io/hs-fs/hubfs/logo2.png?height=40&name=logo2.png)

Open main navigation

Close main navigation

- English
  
  Show submenu for translations
- [Go to brandwizard.io](https://brandwizard.io/)

[Go to brandwizard.io](https://brandwizard.io/)

 Hello. How can we help you?

- There are no suggestions because the search field is empty.

1. [Help Center](https://help.brandwizard.io/knowledge?hsLang=en)
2. [General questions about the service](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en)
3. [API](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#api)

# Reviews v4 API

**Contents:**

- [**Method GET/public/v4/reviews/**](https://help.brandwizard.io/knowledge/reviews-v4-api#GET_public_v4_reviews)
- [**Method POST/public/v4/reviews/{id}/abuse/**](https://help.brandwizard.io/knowledge/reviews-v4-api#POST_public_v4_reviews_id_abuse)
- [**Method PUT/public/v4/reviews/{review\_id}/commands/{command\_id}/**](https://help.brandwizard.io/knowledge/reviews-v4-api#PUT_v4_reviews_review_id_commands_command_id)
- [**Method DELETE/public/v4/reviews/{review\_id}/commands/{command\_id}/**](https://help.brandwizard.io/knowledge/reviews-v4-api#DELETE_v4_reviews_review_id_commands_command_id)
- [**Method PUT/public/v4/reviews/{review\_id}/replies/{reply\_id}/**](https://help.brandwizard.io/knowledge/reviews-v4-api#PUT_public_v4_reviews_review_id_replies_reply_id)
- [**Method DELETE/public/v4/reviews/{review\_id}/replies/{reply\_id}/**](https://help.brandwizard.io/knowledge/reviews-v4-api#DELETE_v4_reviews_review_id_replies_reply_id)
- [**Method POST/public/v4/reviews/{review\_id}/reply/**](https://help.brandwizard.io/knowledge/reviews-v4-api#POST_public_v4_reviews_review_id_reply)
- [**Method PATCH/public/v4/reviews/{review\_id}/status/**](https://help.brandwizard.io/knowledge/reviews-v4-api#PATCH_public_v4_reviews_review_id_status)
- [**Method POST/public/v4/reviews/custom\_reviews/**](https://help.brandwizard.io/knowledge/reviews-v4-api#POST_public_v4_reviews_custom_reviews)
- [**Method PATCH/public/v4/reviews/custom\_reviews/{id}/**](https://help.brandwizard.io/knowledge/reviews-v4-api#PATCH_public_v4_reviews_custom_reviews_id)
- [**Method DELETE/public/v4/reviews/custom\_reviews/{id}/**](https://help.brandwizard.io/knowledge/reviews-v4-api#DELETE_public_v4_reviews_custom_reviews_id)
- [**Method GET/public/v4/reviews/repliers/**](https://help.brandwizard.io/knowledge/reviews-v4-api#GET_public_v4_reviews_repliers)
- [**Method GET/public/v4/reviews/statistic/**](https://help.brandwizard.io/knowledge/reviews-v4-api#GET_public_v4_reviews_statistic)

---

In this documentation, you can find a description of the methods of the [BrandWizard API](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4) in the **Reviews v4** section.

 

![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/145b68576a66d65a29eac1c474995e573a44ffff)

 

**Method GET**[**/public/v4/reviews/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_list)

- **Description**: Get a list of review objects.
- **Request Parameters**:

| **Parameter** | **Type** | **Required?** | **Description** |
| --- | --- | --- | --- |
| abuse\_statuses | array\[string\] | No | Complaint statuses (latest per review): - not\_sent – complaint not sent; - sent – complaint sent; - accepted – complaint accepted; - declined – complaint declined. |
| action\_abuse | boolean | No | Whether complaints can be submitted for reviews: Yes/No |
| action\_reply | boolean | No | Whether replies are possible: Yes/No |
| all\_responsible\_users | string | No | All responsible employees |
| brand\_ids | list\[integer\] | No | List of brand IDs |
| catalog\_ids | list\[integer\] | No | List of catalog IDs |
| city\_ids | list\[integer\] | No | List of city IDs |
| company\_group\_ids | list\[integer\] | No | List of company group IDs |
| company\_ids | list\[integer\] | No | List of company IDs |
| created\_at\_gt | string | No | Reviews created after the provided date |
| cursor | string | No | Set cursor for returning results |
| date\_gte | string | No | Show reviews from this date |
| date\_lte | string | No | Show reviews up to this date |
| has\_abuse | boolean | No | Whether complaints were submitted via BrandWizard cabinet: Yes/No |
| has\_changes | boolean | No | Whether the review was changed: Yes/No |
| in\_trash | boolean | No | Whether the review was deleted: Yes/No |
| is\_replied | boolean | No | With reply / without reply: Yes/No |
| moderated | boolean | No | Whether the review passed moderation: Yes/No |
| moderated\_change\_date\_gte | string | No | Moderation started on this date |
| moderated\_change\_date\_lte | string | No | Moderation ended on this date |
| per\_page | integer | No | Number of results per page |
| process\_status | list\[integer\] | No | Review processing status: Processed; Not processed; Coordination; In process; Decided; Request information from client; Bonus provided to client; Answer given via catalog; Complaint submitted; Review deleted |
| rating | list\[integer\] | No | Ratings (if not specified, pass 0) |
| rating\_type | string | No | Review type by rating: positive, negative, neutral |
| replier\_ids | list\[integer\] | No | List of BrandWizard employees who replied |
| responsible\_users | list\[integer\] | No | Employees responsible for processing the review |
| target | string | No | Reviews on brand / reviews on company |
| without\_text | boolean | No | With text / without text: Yes/No |

- **Response Fields**:
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | next | string | Link to the next page |  |
  | previous | string | Link to the previous page |  |
  | per\_page | integer | Number of results per page |  |
  | results | author | string | Review author’s name |
  | created\_in\_catalog | string | Date created in catalog |  |
  | created\_in\_rd | string | Date created in BrandWizard cabinet |  |
  | parsed\_at | string | Date review collected into cabinet |  |
  | comment | string | Review text |  |
  | deleted\_at | string | Deletion date |  |
  | able\_to\_reply | boolean | Ability to reply: Yes/No |  |
  | id | integer | Review ID |  |
  | rating | number | Rating |  |
  | origin\_url | string | Link to review in catalog |  |
  | location\_url | string | Link to location in catalog |  |
  | able\_to\_abuse | boolean | Ability to submit complaint: Yes/No |  |
  | abuse\_last\_date | string | Date of last complaint submission |  |
  | is\_changed | boolean | Review changed: Yes/No |  |
  | tags | relation\_id | integer | Tag relation ID with review |
  | id | integer | Tag ID |  |
  | title | string | Tag name |  |
  | is\_aspect | boolean | Is aspect: Yes/No (see more details here) |  |
  | folder\_id | integer | Tag group ID |  |
  | catalog\_id | integer | Catalog ID |  |
  | company | id | integer | Company ID |
  | name | string | Company name |  |
  | code | string | Branch code |  |
  | address | country | string | Country where the company is located |
  | country\_code | string | Country code |  |
  | region | string | Region |  |
  | city | string | City |  |
  | street | string | Street |  |
  | housenumber | string | House number |  |
  | postcode | string | Postal code |  |
  | brand | id | integer | Brand ID |
  | name | string | Brand name |  |
  | process\_status | list\[integer\] | Review processing status: processed; not\_processed; coordination; in\_process; decided; request\_info; bonus\_provided; answer\_in\_catalog; abuse\_sent; review\_deleted; review\_changed |  |
  | able\_to\_change\_responsible\_user | boolean | Ability to change responsible employee: Yes/No |  |
  | responsible\_user | id | integer | Responsible employee ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | user\_fields | string | Additional information (e.g., email) |  |
  | moderated | boolean | The review has been confirmed. |  |
  | notes | id | integer | Note ID |
  | text | string | Note text |  |
  | created\_at | string | Note creation date |  |
  | updated\_at | string | Note update date |  |
  | user | id | integer | Employee ID who created the note |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | children | author | string | Reply author |
  | created\_in\_catalog | string | Reply creation date in catalog |  |
  | created\_in\_rd | string | Reply creation date in BrandWizard cabinet |  |
  | parsed\_at | string | Date reply collected into cabinet |  |
  | comment | string | Reply text |  |
  | deleted\_at | string | Reply deletion date |  |
  | able\_to\_reply | boolean | Ability to reply: Yes/No |  |
  | type | string | Reply type (reply/command) |  |
  | reply\_id | integer | Reply ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; reply\_id is filled when reply is collected from catalog and saved in BrandWizard DB) |  |
  | command\_id | integer | Command ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; command\_id is filled when user writes a reply and sends it via API ([https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4\_reviews\_reply\_create](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)) or BrandWizard cabinet; once reply is published and collected, command\_id becomes empty and reply\_id is displayed) |  |
  | is\_company\_comment | boolean | Official company reply: Yes/No |  |
  | is\_autoreply | boolean | Auto reply: Yes/No |  |
  | able\_to\_edit | boolean | Ability to edit reply: Yes/No |  |
  | able\_to\_delete | boolean | Ability to delete reply: Yes/No |  |
  | user | id | integer | User ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | editable\_until | string | Shows until when reply can be edited for secondary catalogs |  |
  | last\_changes\_date | string | Date of last reply change |  |
  | additional\_author\_name | string | Reviewer's name. Filled in when the review is received from the **Review Generator**; in other cases, the field will be empty. |  |
  | additional\_author\_email | string | Reviewer's email. Filled in when the review is received from the **Review Generator**; in other cases, the field will be empty. |  |
  | additional\_author\_phone | string | Reviewer's phone number. Filled in when the review is received from the **Review Generator**; in other cases, the field will be empty. |  |

 

---

 

**Method POST**[**/public/v4/reviews/{id}/abuse/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_abuse_create)

- **Description**: Complain about the review. Specify a unique identifier (id) and reason in the body of the request (reason).
- **Request Parameters**:

| **Parameter** | **Type** | **Required?** | **Description** |
| --- | --- | --- | --- |
| id | string | Yes | Review ID |

- **Request body:**

| **Field** | **Type** | **Description** |
| --- | --- | --- |
| reason | string | Complaint reason |

- **Response Fields**:
  
  | **Field** | **Type** | **Description** |
  | --- | --- | --- |
  | id | integer | Complaint ID |
  | review\_id | integer | Review ID |
  | reason | string | Complaint reason |

 

---

 

**Method PUT**[**/public/v4/reviews/{review\_id}/commands/{command\_id}/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_commands_update)

- **Description**: Edit reply (if reply is not delivered yet).
- **Request Parameters**:

| **Parameter** | **Type** | **Required?** | **Description** |
| --- | --- | --- | --- |
| command\_id | string | Yes | Command ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; command\_id is filled when user writes a reply and sends it via API ([https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4\_reviews\_reply\_create](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)) or BrandWizard cabinet; once reply is published and collected, command\_id becomes empty and reply\_id is displayed) |
| review\_id | string | Yes | Review ID |

- **Request body:**

| **Field** | **Type** | **Description** |
| --- | --- | --- |
| comment | string | Reply text |

- **Response Fields**:
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | reply\_id | string | Reply ID in BrandWizard (fields reply\_id and command\_id cannot be filled simultaneously. The reply\_id field will be filled when the reply is collected from the catalog and saved in the BrandWizard database). |  |
  | command\_id | integer | Command ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; command\_id is filled when user writes a reply and sends it via API ([https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4\_reviews\_reply\_create](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)) or BrandWizard cabinet; once reply is published and collected, command\_id becomes empty and reply\_id is displayed) |  |
  | type | string | Reply type (reply/command) |  |
  | author | string | Reply author |  |
  | comment | string | Reply text |  |
  | created\_in\_rd | string | Reply creation date in BrandWizard cabinet |  |
  | created\_in\_catalog | string | Reply creation date in catalog |  |
  | parsed\_at | string | Date reply collected from catalog into cabinet |  |
  | deleted\_at | string | Reply deletion date |  |
  | is\_company\_comment | boolean | Official company reply: Yes/No |  |
  | is\_autoreply | boolean | Auto reply: Yes/No |  |
  | able\_to\_reply | boolean | Ability to reply: Yes/No |  |
  | able\_to\_edit | boolean | Ability to edit reply: Yes/No |  |
  | able\_to\_delete | boolean | Ability to delete reply: Yes/No |  |
  | children | - | List of replies to the review reply |  |
  | user | id | integer | User ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | editable\_until | string | Shows until when the reply can be edited for secondary catalogs |  |

 

---

 

**Method DELETE**[**/public/v4/reviews/{review\_id}/commands/{command\_id}/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_commands_destroy)

- **Description**: Delete reply (if reply is not delivered yet or reply has undelivered changes).
- **Request Parameters**:
  
  | **Parameter** | **Type** | **Required?** | **Description** |
  | --- | --- | --- | --- |
  | command\_id | string | Yes | Command ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; command\_id is filled when user writes a reply and sends it via API ([https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4\_reviews\_reply\_create](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)) or BrandWizard cabinet; once reply is published and collected, command\_id becomes empty and reply\_id is displayed) |
  | review\_id | string | Yes | Review ID |
- **Response Fields**:
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | reply\_id | string | Reply ID in BrandWizard (fields reply\_id and command\_id cannot be filled simultaneously. The reply\_id field will be filled when the reply is collected from the catalog and saved in the BrandWizard database). |  |
  | command\_id | integer | Command ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; command\_id is filled when user writes a reply and sends it via API ([https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4\_reviews\_reply\_create](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)) or BrandWizard cabinet; once reply is published and collected, command\_id becomes empty and reply\_id is displayed) |  |
  | type | string | Reply type (reply/command) |  |
  | author | string | Reply author |  |
  | comment | string | Reply text |  |
  | created\_in\_rd | string | Reply creation date in BrandWizard cabinet |  |
  | created\_in\_catalog | string | Reply creation date in catalog |  |
  | parsed\_at | string | Date reply collected from catalog into cabinet |  |
  | deleted\_at | string | Reply deletion date |  |
  | is\_company\_comment | boolean | Official company reply: Yes/No |  |
  | is\_autoreply | boolean | Auto reply: Yes/No |  |
  | able\_to\_reply | boolean | Ability to reply: Yes/No |  |
  | able\_to\_edit | boolean | Ability to edit reply: Yes/No |  |
  | able\_to\_delete | boolean | Ability to delete reply: Yes/No |  |
  | children | - | List of replies to the review reply |  |
  | user | id | integer | User ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name\> | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | editable\_until | string | Shows until when the reply can be edited for secondary catalogs |  |

 

---

 

**Method PUT**[**/public/v4/reviews/{review\_id}/replies/{reply\_id}/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_replies_update)

- **Description**: Edit reply (if reply is already delivered).
- **Request Parameters**:
  
  | **Parameter** | **Type** | **Required?** | **Description** |
  | --- | --- | --- | --- |
  | reply\_id | string | Yes | Reply ID |
  | review\_id | string | Yes | Review ID |
- **Request body:**
  
  | **Field** | **Type** | **Description** |
  | --- | --- | --- |
  | comment | string | Reply text |
- **Response Fields**:
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | reply\_id | string | Reply ID in BrandWizard (fields reply\_id and command\_id cannot be filled simultaneously. The reply\_id field will be filled when the reply is collected from the catalog and saved in the BrandWizard database). |  |
  | command\_id | integer | Command ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; command\_id is filled when user writes a reply and sends it via API ([https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4\_reviews\_reply\_create](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)) or BrandWizard cabinet; once reply is published and collected, command\_id becomes empty and reply\_id is displayed) |  |
  | type | string | Reply type (reply/command) |  |
  | author | string | Reply author |  |
  | comment | string | Reply text |  |
  | created\_in\_rd | string | Reply creation date in BrandWizard cabinet |  |
  | created\_in\_catalog | string | Reply creation date in catalog |  |
  | parsed\_at | string | Date reply collected from catalog into cabinet |  |
  | deleted\_at | string | Reply deletion date |  |
  | is\_company\_comment | boolean | Official company reply: Yes/No |  |
  | is\_autoreply | boolean | Auto reply: Yes/No |  |
  | able\_to\_reply | boolean | Ability to reply: Yes/No |  |
  | able\_to\_edit | boolean | Ability to edit reply: Yes/No |  |
  | able\_to\_delete | boolean | Ability to delete reply: Yes/No |  |
  | children | - | List of replies to the review reply |  |
  | user | id | integer | User ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | editable\_until | string | Shows until when the reply can be edited for secondary catalogs |  |

 

---

 

**Method DELETE**[**/public/v4/reviews/{review\_id}/replies/{reply\_id}/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_replies_destroy)

- **Description**: Delete reply (if reply is already delivered).
- **Request Parameters**:
  
  | **Parameter** | **Type** | **Required?** | **Description** |
  | --- | --- | --- | --- |
  | reply\_id | string | Yes | Reply ID |
  | review\_id | string | Yes | Review ID |
- **Response Fields**:
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | reply\_id | string | Reply ID in BrandWizard (fields reply\_id and command\_id cannot be filled simultaneously. The reply\_id field will be filled when the reply is collected from the catalog and saved in the BrandWizard database). |  |
  | command\_id | integer | Command ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; command\_id is filled when user writes a reply and sends it via API ([https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4\_reviews\_reply\_create](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)) or BrandWizard cabinet; once reply is published and collected, command\_id becomes empty and reply\_id is displayed) |  |
  | type | string | Reply type (reply/command) |  |
  | author | string | Reply author |  |
  | comment | string | Reply text |  |
  | created\_in\_rd | string | Reply creation date in BrandWizard cabinet |  |
  | created\_in\_catalog | string | Reply creation date in catalog |  |
  | parsed\_at | string | Date reply collected from catalog into cabinet |  |
  | deleted\_at | string | Reply deletion date |  |
  | is\_company\_comment | boolean | Official company reply: Yes/No |  |
  | is\_autoreply | boolean | Auto reply: Yes/No |  |
  | able\_to\_reply | boolean | Ability to reply: Yes/No |  |
  | able\_to\_edit | boolean | Ability to edit reply: Yes/No |  |
  | able\_to\_delete | boolean | Ability to delete reply: Yes/No |  |
  | children | - | List of replies to the review reply |  |
  | user | id | integer | User ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name\< | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | editable\_until | string | Shows until when the reply can be edited for secondary catalogs |  |

 

---

 

**Method POST**[**/public/v4/reviews/{review\_id}/reply/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)

- **Description**: Respond to a review using a unique review ID.
- **Request Parameters**:
  
  | **Parameter** | **Type** | **Required?** | **Description** |
  | --- | --- | --- | --- |
  | review\_id | string | Yes | Review ID |
- **Request body:**
  
  | **Field** | **Type** | **Description** |
  | --- | --- | --- |
  | comment | string | Reply text |
- **Response Fields**:
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | reply\_id | string | Reply ID in BrandWizard (fields reply\_id and command\_id cannot be filled simultaneously. The reply\_id field will be filled when the reply is collected from the catalog and saved in the BrandWizard database). |  |
  | command\_id | integer | Command ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; command\_id is filled when user writes a reply and sends it via API ([https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4\_reviews\_reply\_create](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)) or BrandWizard cabinet; once reply is published and collected, command\_id becomes empty and reply\_id is displayed) |  |
  | type | string | Reply type (reply/command) |  |
  | author | string | Reply author |  |
  | comment | string | Reply text |  |
  | created\_in\_rd | string | Reply creation date in BrandWizard cabinet |  |
  | created\_in\_catalog | string | Reply creation date in catalog |  |
  | parsed\_at | string | Date reply collected from catalog into cabinet |  |
  | deleted\_at | string | Reply deletion date |  |
  | is\_company\_comment | boolean | Official company reply: Yes/No |  |
  | is\_autoreply | boolean | Auto reply: Yes/No |  |
  | able\_to\_reply | boolean | Ability to reply: Yes/No |  |
  | able\_to\_edit | boolean | Ability to edit reply: Yes/No |  |
  | able\_to\_delete | boolean | Ability to delete reply: Yes/No |  |
  | children | - | List of replies to the review reply |  |
  | user | id | integer | User ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | editable\_until | string | Shows until when the reply can be edited for secondary catalogs |  |

 

---

 

**Method PATCH**[**/public/v4/reviews/{review\_id}/status/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_status_partial_update)

- **Description**: Change process\_status of review.
- **Request Parameters**:
  
  | **Parameter** | **Type** | **Required?** | **Description** |
  | --- | --- | --- | --- |
  | review\_id | string | Yes | Review ID |
- **Request body:**
  
  | **Field** | **Type** | **Description** |
  | --- | --- | --- |
  | process\_status | list\[integer\] | Review processing status: processed; not\_processed; coordination; in\_process; decided; request\_info; bonus\_provided; answer\_in\_catalog; abuse\_sent; review\_deleted; review\_changed |
- **Response Fields**: None.

 

---

 

**Method POST**[**/public/v4/reviews/custom\_reviews/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_custom_reviews_create)

- **Description**: Create a custom review object.
- **Request Parameters**: None.
- **Request body:**
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | brand\_id | integer | Brand ID |  |
  | origin\_url | string | Customer review link |  |
  | company\_id | integer | Company ID |  |
  | catalog\_id | integer | Catalog ID |  |
  | creation\_time | string | Creation date |  |
  | author | string | Author’s name |  |
  | phone | string | Author’s phone number |  |
  | comment | string | Review text |  |
  | rating | integer | Review rating |  |
  | user\_fields | - | Additional information can be specified here, for example email |  |
  | tag\_ids | integer | Tag IDs |  |
  | notes | text | string | Note text |
- **Response Fields**:
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | author | string | Review author’s name |  |
  | created\_in\_catalog | string | Date created in catalog |  |
  | created\_in\_rd | string | Date created in BrandWizard cabinet |  |
  | parsed\_at | string | Date review collected into cabinet |  |
  | comment | string | Review text |  |
  | deleted\_at | string | Deletion date |  |
  | able\_to\_reply | boolean | Ability to reply: Yes/No |  |
  | id | integer | Review ID |  |
  | rating | number | Rating |  |
  | origin\_url | string | Link to review in catalog |  |
  | location\_url | string | Link to location in catalog |  |
  | able\_to\_abuse | boolean | Ability to submit complaint: Yes/No |  |
  | abuse\_last\_date | string | Date of last complaint submission |  |
  | is\_changed | boolean | Review changed: Yes/No |  |
  | tags | relation\_id | integer | Tag relation ID with review |
  | id | integer | Tag ID |  |
  | title | string | Tag name |  |
  | is\_aspect | boolean | Is aspect: Yes/No (see more details here) |  |
  | folder\_id | integer | Tag group ID |  |
  | catalog\_id | integer | Catalog ID |  |
  | company | id | integer | Company ID |
  | name | string | Company name |  |
  | code | string | Branch code |  |
  | address | country | string | Country where the company is located |
  | country\_code | string | Country code |  |
  | region | string | Region |  |
  | city | string | City |  |
  | street | string | Street |  |
  | housenumber | string | House number |  |
  | postcode | string | Postal code |  |
  | brand | id | integer | Brand ID |
  | name | string | Brand name |  |
  | process\_status | list\[integer\] | Review processing status: processed; not\_processed; coordination; in\_process; decided; request\_info; bonus\_provided; answer\_in\_catalog; abuse\_sent; review\_deleted; review\_changed |  |
  | able\_to\_change\_status | boolean | Ability to change status: Yes/No |  |
  | able\_to\_change\_responsible\_user | boolean | Ability to change responsible employee: Yes/No |  |
  | responsible\_user | id | integer | Responsible employee ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | user\_fields | string | Additional information (e.g., email) |  |
  | reply\_time\_in\_catalog | integer | Reply time in catalog |  |
  | reply\_time\_in\_rd | integer | Reply time in BrandWizard cabinet |  |
  | moderated | boolean | Reply verified: Yes/No |  |
  | children | author | string | Reply author |
  | created\_in\_catalog | string | Reply creation date in catalog |  |
  | created\_in\_rd | string | Reply creation date in BrandWizard cabinet |  |
  | parsed\_at | string | Date reply collected from catalog into cabinet |  |
  | comment | string | Reply text |  |
  | deleted\_at | string | Reply deletion date |  |
  | able\_to\_reply | boolean | Ability to reply: Yes/No |  |
  | type | string | Reply type (reply/command) |  |
  | reply\_id | integer | Reply ID in BrandWizard (fields reply\_id and command\_id cannot be filled simultaneously; reply\_id is filled when reply is collected from catalog and saved in BrandWizard DB) |  |
  | command\_id | integer | Command ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; command\_id is filled when user writes a reply and sends it via API ([https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4\_reviews\_reply\_create](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)) or BrandWizard cabinet; once reply is published and collected, command\_id becomes empty and reply\_id is displayed) |  |
  | is\_company\_comment | boolean | Official company reply: Yes/No |  |
  | is\_autoreply | boolean | Auto reply: Yes/No |  |
  | able\_to\_edit | boolean | Ability to edit reply: Yes/No |  |
  | able\_to\_delete | boolean | Ability to delete reply: Yes/No |  |
  | user | id | integer | User ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | editable\_until | string | Shows until when the reply can be edited for secondary catalogs |  |
  | status | string | Command delivery status:  - init\_status (initial state); - sent\_status (reply successfully sent); - delivered\_status (reply collected from catalog); - permission\_problem\_status (no access or rights); - review\_not\_found\_status (review deleted or unavailable in catalog); - exception\_status (failed to send); - cancelled\_status (reply no longer required); - outdated\_status (command no longer relevant); - moderation\_failed\_status (reply moderation failed); - resend\_status (command must be resent to catalog). |  |
  | action | string | Action type: create/edit/delete |  |
  | last\_changes\_date | string | Date of last reply change |  |
  | last\_changes\_date | string | Date of last review change |  |
  | notes | string | Note on review |  |

 

---

 

**Method PATCH**[**/public/v4/reviews/custom\_reviews/{id}/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_custom_reviews_partial_update)

- **Description**: Update a custom review object.
- **Request Parameters**:
  
  | **Parameter** | **Type** | **Required?** | **Description** |
  | --- | --- | --- | --- |
  | id | string | Yes | Custom review ID |
- **Request body:**
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | brand\_id | integer | Brand ID |  |
  | origin\_url | string | Customer review link |  |
  | company\_id | integer | Company ID |  |
  | catalog\_id | integer | Catalog ID |  |
  | creation\_time | string | Creation date |  |
  | author | string | Author’s name |  |
  | phone | string | Author’s phone number |  |
  | comment | string | Review text |  |
  | rating | integer | Review rating |  |
  | user\_fields | - | Additional information can be specified here, for example email |  |
  | tag\_ids | integer | Tag IDs |  |
  | notes | id | integer | Note ID |
  | text | string | Note text |  |
- **Response Fields**:
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | author | string | Review author’s name |  |
  | created\_in\_catalog | string | Date created in catalog |  |
  | created\_in\_rd | string | Date created in BrandWizard cabinet |  |
  | parsed\_at | string | Date review collected into cabinet |  |
  | comment | string | Review text |  |
  | deleted\_at | string | Deletion date |  |
  | able\_to\_reply | boolean | Ability to delete: Yes/No |  |
  | id | integer | Review ID |  |
  | rating | number | Rating |  |
  | origin\_url | string | Link to review in catalog |  |
  | location\_url | string | Link to location in catalog |  |
  | able\_to\_abuse | boolean | Ability to submit complaint: Yes/No |  |
  | abuse\_last\_date | string | Date of last complaint submission |  |
  | is\_changed | boolean | Review changed: Yes/No |  |
  | tags | relation\_id | integer | Tag relation ID with review |
  | id | integer | Tag ID |  |
  | title | string | Tag name |  |
  | is\_aspect | boolean | Is aspect: Yes/No (see more details [here](https://roketdata.helpdeskeddy.com/en/knowledge_base/art/735/cat/14)) |  |
  | folder\_id | integer | Tag group ID |  |
  | catalog\_id | integer | Catalog ID |  |
  | company | id | integer | Company ID |
  | name | string | Company name |  |
  | code | string | Branch code |  |
  | address | country | string | Country where the company is located |
  | country\_code | string | Country code |  |
  | region | string | Region |  |
  | city | string | City |  |
  | street | string | Street |  |
  | housenumber | string | House number |  |
  | postcode | string | Postal code |  |
  | brand | id | integer | Brand ID |
  | name | string | Brand name |  |
  | process\_status | list\[integer\] | Review processing status: processed; not\_processed; coordination; in\_process; decided; request\_info; bonus\_provided; answer\_in\_catalog; abuse\_sent; review\_deleted; review\_changed |  |
  | able\_to\_change\_status | boolean | Ability to change status: Yes/No |  |
  | able\_to\_change\_responsible\_user | boolean | Ability to change responsible employee: Yes/No |  |
  | responsible\_user | id | integer | Responsible employee ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | user\_fields | string | Additional information (e.g., email) |  |
  | reply\_time\_in\_catalog | integer | Reply time in catalog |  |
  | reply\_time\_in\_rd | integer | Reply time in BrandWizard cabinet |  |
  | moderated | boolean | Reply verified: Yes/No |  |
  | children | author | string | Reply author |
  | created\_in\_catalog | string | Reply creation date in catalog |  |
  | created\_in\_rd | string | Reply creation date in BrandWizard cabinet |  |
  | parsed\_at | string | Date reply collected from catalog into cabinet |  |
  | comment | string | Reply text |  |
  | deleted\_at | string | Reply deletion date |  |
  | able\_to\_reply | boolean | Ability to reply: Yes/No |  |
  | type | string | Reply type (reply/command) |  |
  | reply\_id | integer | Reply ID in BrandWizard (fields reply\_id and command\_id cannot be filled simultaneously; reply\_id is filled when reply is collected from catalog and saved in BrandWizard DB) |  |
  | command\_id | integer | Command ID in BrandWizard (reply\_id and command\_id cannot be filled simultaneously; command\_id is filled when user writes a reply and sends it via API ([https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4\_reviews\_reply\_create](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create)) or BrandWizard cabinet; once reply is published and collected, command\_id becomes empty and reply\_id is displayed) |  |
  | is\_company\_comment | boolean | Official company reply: Yes/No |  |
  | is\_autoreply | boolean | Auto reply: Yes/No |  |
  | able\_to\_edit | boolean | Ability to edit reply: Yes/No |  |
  | able\_to\_delete | boolean | Ability to delete reply: Yes/No |  |
  | user | id | integer | User ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |
  | editable\_until | string | Shows until when the reply can be edited for secondary catalogs |  |
  | status | string | Command delivery status:  - init\_status (initial state); - sent\_status (reply successfully sent); - delivered\_status (reply collected from catalog); - permission\_problem\_status (no access or rights); - review\_not\_found\_status (review deleted or unavailable in catalog); - exception\_status (failed to send); - cancelled\_status (reply no longer required); - outdated\_status (command no longer relevant); - moderation\_failed\_status (reply moderation failed); - resend\_status (command must be resent to catalog). |  |
  | action | string | Action type: create/edit/delete |  |
  | last\_changes\_date | string | Date of last reply change |  |
  | last\_changes\_date | string | Date of last review change |  |
  | notes | string | Note on review |  |

 

---

 

**Method DELETE**[**/public/v4/reviews/custom\_reviews/{id}/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_custom_reviews_destroy)

- **Description**: Delete a custom review object.
- **Request Parameters**:
  
  | **Parameter** | **Type** | **Required?** | **Description** |
  | --- | --- | --- | --- |
  | id | string | Yes | Custom review ID |
- **Response Fields**: None.

 

---

 

**Method GET**[**/public/v4/reviews/repliers/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_repliers_list)

- **Description**: Get a list of users who have responded to reviews.
- **Request Parameters**:
  
  | **Parameter** | **Type** | **Required?** | **Description** |
  | --- | --- | --- | --- |
  | action\_abuse | boolean | No | Whether complaints can be submitted for reviews: Yes/No |
  | action\_reply | boolean | No | Whether replies are possible: Yes/No |
  | all\_responsible\_users | string | No | All responsible employees |
  | brand\_ids | list\[integer\] | No | List of brand IDs |
  | catalog\_ids | list\[integer\] | No | List of catalog IDs |
  | city\_ids | list\[integer\] | No | List of city IDs |
  | company\_group\_ids | list\[integer\] | No | List of company group IDs |
  | company\_ids | list\[integer\] | No | List of company IDs |
  | created\_at\_gt | string | No | Reviews created after the provided date |
  | date\_gte | string | No | Show reviews from this date |
  | date\_lte | string | No | Show reviews up to this date |
  | has\_abuse | boolean | No | Whether complaints were submitted via BrandWizard cabinet: Yes/No |
  | has\_changes | boolean | No | Whether the review was changed: Yes/No |
  | in\_trash | boolean | No | Whether the review was deleted: Yes/No |
  | is\_replied | boolean | No | With reply / without reply: Yes/No |
  | moderated | boolean | No | Whether the review passed moderation: Yes/No |
  | process\_status | list\[string\] | No | Review processing status: Processed; Not processed; Coordination; In process; Decided; Request information from client; Bonus provided to client; Answer given via catalog; Complaint submitted; Review deleted |
  | rating | list\[integer\] | No | Ratings (if not specified, pass 0) |
  | rating\_type | string | No | Review type by rating: positive, negative, neutral |
  | replier\_ids | list\[integer\] | No | List of BrandWizard employees who replied |
  | responsible\_users | list\[integer\] | No | Employees responsible for processing the review |
  | target | string | No | Reviews on brand / reviews on company |
  | without\_text | boolean | No | With text / without text: Yes/No |
- **Response Fields**:
  
  | **Field** | **Type** | **Description** |  |
  | --- | --- | --- | --- |
  | results | id | integer | User ID |
  | email | string | Employee email |  |
  | first\_name | string | First name |  |
  | last\_name | string | Last name |  |
  | full\_name | string | Full name |  |
  | is\_agency | boolean | Responsible user is a BrandWizard agency employee |  |

 

---

 

**Method GET**[**/public/v4/reviews/statistic/**](https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_statistic_retrieve)

- **Description**: Get statistics on reviews.
- **Request Parameters**:
  
  | **Parameter** | **Type** | **Required?** | **Description** |
  | --- | --- | --- | --- |
  | action\_abuse | boolean | No | Whether complaints can be submitted for reviews: Yes/No |
  | action\_reply | boolean | No | Whether replies are possible: Yes/No |
  | all\_responsible\_users | string | No | All responsible employees |
  | brand\_ids | list\[integer\] | No | List of brand IDs |
  | catalog\_ids | list\[integer\] | No | List of catalog IDs |
  | city\_ids | list\[integer\] | No | List of city IDs |
  | company\_group\_ids | list\[integer\] | No | List of company group IDs |
  | company\_ids | list\[integer\] | No | List of company IDs |
  | created\_at\_gt | string | No | Reviews created after the provided date |
  | date\_gte | string | No | Show reviews from this date |
  | date\_lte | string | No | Show reviews up to this date |
  | has\_abuse | boolean | No | Whether complaints were submitted via BrandWizard cabinet: Yes/No |
  | has\_changes | boolean | No | Whether the review was changed: Yes/No |
  | in\_trash | boolean | No | Whether the review was deleted: Yes/No |
  | is\_replied | boolean | No | With reply / without reply: Yes/No |
  | moderated | boolean | No | Whether the review passed moderation: Yes/No |
  | process\_status | list\[string\] | No | Review processing status: Processed; Not processed; Coordination; In process; Decided; Request information from client; Bonus provided to client; Answer given via catalog; Complaint submitted; Review deleted |
  | rating | list\[integer\] | No | Ratings (if not specified, pass 0) |
  | rating\_type | string | No | Review type by rating: positive, negative, neutral |
  | replier\_ids | list\[integer\] | No | List of BrandWizard employees who replied |
  | responsible\_users | list\[integer\] | No | Employees responsible for processing the review |
  | target | string | No | Reviews on brand / reviews on company |
  | without\_text | boolean | No | With text / without text: Yes/No |
- **Response Fields**:
  
  | **Field** | **Type** | **Description** |
  | --- | --- | --- |
  | count | integer | Number of reviews |
  | negative | integer | Number of negative reviews |
  | neutral | integer | Number of neutral reviews |
  | positive | integer | Number of positive reviews |
  | rating\_avg | number | Average rating |

- [General questions about the service](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#main-content)

    - [FAQ](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#faq)
    - [Creating and editing a company](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#creating-and-editing-a-company)
    - [Working with sources](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#working-with-sources)
    - [Work with reviews](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#work-with-reviews)
    - [Working with a Photo tool](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#working-with-a-photo-tool)
    - [Google](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#google)
    - [2GIS (URBI)](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#2gis-urbi)
    - [Facebook](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#facebook)
    - [Yandex](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#yandex)
    - [API](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#api)
- [Where to start?](https://help.brandwizard.io/knowledge/where-to-start?hsLang=en)
- [Dashboard](https://help.brandwizard.io/knowledge/dashboard?hsLang=en)
- [My companies](https://help.brandwizard.io/knowledge/my-companies?hsLang=en)
- [Create/Edit company in Personal account](https://help.brandwizard.io/knowledge/create-edit-company-in-personal-account?hsLang=en)
- [Sources](https://help.brandwizard.io/knowledge/sources?hsLang=en)
- [Review Center](https://help.brandwizard.io/knowledge/review-center?hsLang=en)
- [Tags](https://help.brandwizard.io/knowledge/tags?hsLang=en)
- [Auto-replies](https://help.brandwizard.io/knowledge/auto-replies?hsLang=en)
- [Statistics](https://help.brandwizard.io/knowledge/statistics?hsLang=en)
- [Reputation Analytics](https://help.brandwizard.io/knowledge/reputation-analytics?hsLang=en)
- [Competitors](https://help.brandwizard.io/knowledge/competitors?hsLang=en)
- [Reviews generator](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#main-content)

    - [QR Codes](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#qr-codes)
    - [Analytics](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#analytics)
    - [Promo codes](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#promo-codes)
    - [Questionnaires](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#questionnaires)
- [Questions & Answers](https://help.brandwizard.io/knowledge/questions-answers?hsLang=en)
- [Photo & Video](https://help.brandwizard.io/knowledge/photo-video?hsLang=en)
- [Presence analytics](https://help.brandwizard.io/knowledge/presence-analytics?hsLang=en)
- [Reviews widget](https://help.brandwizard.io/knowledge/reviews-widget?hsLang=en)
- [Store locator](https://help.brandwizard.io/knowledge/store-locator?hsLang=en)
- [Multichat](https://help.brandwizard.io/knowledge/multichat?hsLang=en#main-content)

    - [Where to start?](https://help.brandwizard.io/knowledge/multichat?hsLang=en#where-to-start)
    - [Adding inboxes](https://help.brandwizard.io/knowledge/multichat?hsLang=en#adding-inboxes)
    - [Conversations](https://help.brandwizard.io/knowledge/multichat?hsLang=en#conversations)
    - [Contacts](https://help.brandwizard.io/knowledge/multichat?hsLang=en#contacts)
    - [Settings](https://help.brandwizard.io/knowledge/multichat?hsLang=en#settings)
    - [Reports](https://help.brandwizard.io/knowledge/multichat?hsLang=en#reports)
    - [Additional features](https://help.brandwizard.io/knowledge/multichat?hsLang=en#additional-features)
- [Posts](https://help.brandwizard.io/knowledge/posts?hsLang=en)
- [Duplicates & Fakes](https://help.brandwizard.io/knowledge/duplicates-fakes?hsLang=en)
- [Products & Prices](https://help.brandwizard.io/knowledge/products-prices?hsLang=en)
- [Plans & Limits](https://help.brandwizard.io/knowledge/plans-limits?hsLang=en)
- [Profile](https://help.brandwizard.io/knowledge/profile?hsLang=en)
- [Users](https://help.brandwizard.io/knowledge/users?hsLang=en)
- [Account settings](https://help.brandwizard.io/knowledge/account-settings?hsLang=en)
- [Groups of companies section](https://help.brandwizard.io/knowledge/groups-of-companies-section?hsLang=en)
- [Notifications settings](https://help.brandwizard.io/knowledge/notifications-settings?hsLang=en)

# BrandWizard

brandwizard.io Help Center

Copyright © 2026, BrandWizard