---
updatedAt: 2026-03-30T09:13:53.000Z
agentTools:
  projectIndex: https://developers.bazaarvoice.com/v1.0-ConversationsAPI/llms.txt
---

# Preview Review Form

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Conversation Submission API",
    "x-api-id": "2b36747d-6cb9-42e2-a7d8-22c3979abeee",
    "x-audience": "external-public",
    "description": "The Conversation Submission API is a comprehensive platform for submitting and managing content such as Reviews, Questions, Answers, Comments, Feedback, and media uploads, as well as handling Notifications for CV2 clients.",
    "version": "1.0.0",
    "contact": {
      "email": "submission-team@bazaarvoice.com",
      "name": "Submission Team",
      "url": "https://developer.bazaarvoice.com/conversations-api/home"
    }
  },
  "servers": [
    {
      "url": "https://stg.api.bazaarvoice.com",
      "description": "Conversation-Submission API STG"
    }
  ],
  "tags": [
    {
      "name": "Submitreview"
    }
  ],
  "paths": {
    "/data/submitreview.json": {
      "get": {
        "tags": [
          "Submitreview"
        ],
        "operationId": "GetReviewPreview",
        "summary": "Preview Review Form",
        "parameters": [
          {
            "name": "ApiVersion",
            "in": "query",
            "required": true,
            "schema": {
              "type": "number"
            },
            "description": "The API version, e.g. 5.4.",
            "example": "5.4"
          },
          {
            "name": "PassKey",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "API key is required to authenticate API user and check permission to access particular client's data.",
            "example": "caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4"
          },
          {
            "name": "ProductId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The id of the product for which submission form is requested.",
            "example": "1000001"
          },
          {
            "name": "Action",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "The submission action to take",
            "example": "Preview"
          },
          {
            "name": "Rating",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "description": "Value is positive integer between 1 and 5, and represents review overall rating.",
            "example": 5
          },
          {
            "name": "ReviewText",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 50,
              "maxLength": 10000
            },
            "description": "Value is review body text.The minimum length is configurable,  default is 50 but can be lower.",
            "example": "test review Text test review Text test review Text test review Text"
          },
          {
            "name": "Title",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            },
            "description": "Value is content title text. The minimum and maximum lengths are configurable. The current default is 50 characters, but can be lower to 1 or higher to 255.",
            "example": "test title"
          },
          {
            "name": "UserNickname",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 4,
              "maxLength": 25
            },
            "description": "User nickname display text.",
            "example": "test_nick_name"
          },
          {
            "name": "agreedtotermsandconditions",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "description": "Boolean indicating whether or not the user agreed to the terms and conditions. Required depending on the client's settings.",
            "example": "true"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetReview"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Missing required parameter.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "type": "/problems/bad-request",
                  "title": "Bad Request",
                  "staus": 400,
                  "ERROR_CODE": "ERROR_BAD_REQUEST",
                  "detail": "Missing required parameter - apiversion."
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - Authentication or authorization failed. The provided credentials or authentication tokens are invalid or insufficient.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "type": "/problems/unauthorized",
                  "title": "Unauthorized",
                  "staus": 401,
                  "ERROR_CODE": "ERROR_PARAM_MISSING_USER_ID",
                  "detail": "User authentication required, anonymous submission not allowed."
                }
              }
            }
          },
          "403": {
            "description": "Forbidden.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "type": "/problems/forbidden",
                  "title": "Forbidden",
                  "staus": 403,
                  "ERROR_CODE": "ERROR_FORBIDDEN",
                  "detail": "Content may not be submitted using a GET operation."
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "type": "/problems/not-found",
                  "title": "Not Found",
                  "staus": 404,
                  "ERROR_CODE": "ERROR_NOT_FOUND",
                  "detail": "Review submission endpoint not found"
                }
              }
            }
          },
          "414": {
            "description": "Request-URI too long",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "fault": {
                    "faultstring": "request line size exceeding 7,168",
                    "detail": {
                      "errorcode": "protocol.http.TooBigLine"
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "Unexpected Error",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "type": "/problems/unexpected-error",
                  "title": "Unexpected Error",
                  "staus": 500,
                  "ERROR_CODE": "ERRROR_UNKNOWN",
                  "detail": "An unexpected error has occurred, please retry. Contact Bazaarvoice if the problem persists."
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "GetReview": {
        "type": "object",
        "properties": {
          "Locale": {
            "type": "string",
            "description": "The locale of the review.",
            "pattern": "^[a-z]{2}_[A-Z]{2}$"
          },
          "Errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Type": {
                  "type": "string"
                },
                "Id": {
                  "type": "string"
                }
              }
            }
          },
          "Form": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "Type": {
                  "type": "string"
                },
                "Id": {
                  "type": "string"
                }
              }
            }
          },
          "FormErrors": {
            "type": "object"
          },
          "SubmissionId": {
            "type": "string",
            "description": "The submission ID."
          },
          "Data": {
            "type": "object",
            "properties": {
              "Fields": {
                "type": "object"
              },
              "Groups": {
                "type": "object"
              },
              "FieldsOrder": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "GroupsOrder": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          },
          "TypicalHoursToPost": {
            "type": "number",
            "description": "The typical number of hours it takes for a submission to be posted"
          },
          "Review": {
            "type": "object",
            "properties": {
              "SendEmailAlertWhenCommented": {
                "type": "boolean",
                "description": "Flag indicating whether to send an email alert when the review is commented on."
              },
              "Rating": {
                "type": "number",
                "description": "The rating of the review."
              },
              "SubmissionTime": {
                "type": "string",
                "description": "The submission time of the review.",
                "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}\\+\\d{2}:\\d{2}$"
              },
              "ReviewText": {
                "type": "string",
                "description": "The text content of the review."
              },
              "SubmissionId": {
                "type": "string",
                "description": "The submission ID of the review."
              },
              "Title": {
                "type": "string",
                "description": "The title of the review."
              },
              "IsRecommended": {
                "type": "boolean",
                "description": "Flag indicating whether the review is recommended."
              },
              "TypicalHoursToPost": {
                "type": "number",
                "description": "The typical number of hours it takes for the review to be posted."
              },
              "Id": {
                "type": "string",
                "description": "The ID of the review."
              },
              "SendEmailAlertWhenPublished": {
                "type": "boolean",
                "description": "Flag indicating whether to send an email alert when the review is published."
              }
            }
          },
          "AuthorSubmissionToken": {
            "type": "string"
          },
          "HasErrors": {
            "type": "boolean"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "required": [
          "code",
          "occurredAt"
        ],
        "properties": {
          "type": {
            "type": "string",
            "format": "uri",
            "default": "about:blank"
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
            "minimum": 100,
            "maximum": 599,
            "example": 400
          },
          "detail": {
            "type": "string",
            "description": "A human readable explanation specific to this occurrence of the problem.",
            "example": "Connection to database timed out"
          },
          "instance": {
            "type": "string",
            "format": "uri",
            "description": "An absolute URI that identifies the specific occurrence of the problem."
          },
          "code": {
            "type": "string",
            "example": "ERROR_PARAM_MISSING_PARAMETERS",
            "x-extensible-enum": [
              "ERROR_ACCESS_DENIED",
              "ERROR_FORM_DUPLICATE",
              "ERROR_FORM_EMOJI",
              "ERROR_FORM_REQUIRED",
              "ERROR_FORM_REQUIRED_NICKNAME",
              "ERROR_FORM_TOO_SHORT",
              "ERROR_DUPLICATE_SUBMISSION",
              "ERROR_PARAM_INVALID_API_KEY",
              "ERROR_PARAM_INVALID_LOCALE",
              "ERROR_PARAM_INVALID_PARAMETERS",
              "ERROR_PARAM_MISSING_SUBJECT_ID",
              "ERROR_PARAM_MISSING_USER_ID",
              "ERROR_REQUEST_LIMIT_REACHED",
              "ERROR_UNKNOWN",
              "ERROR_UNSUPPORTED",
              "ERROR_NOT_FOUND",
              "ERROR_FORBIDDEN",
              "ERROR_REQUEST_LINE_TOO_LARGE"
            ]
          },
          "occurredAt": {
            "type": "string",
            "format": "date-time",
            "example": "2023-07-19T09:10:04.446Z"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```