Submit a text for review

post /text/Review
This endpoint allows users to add or edit a review for a product or category. You can specify the review details, such as the record ID, language, and content of the review, and update it as needed.

Requirements

Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Parameter Name Type Description
id string, optional The review ID. If provided, it will edit the existing review. Otherwise, a new review is created.
type string, required Specifies the type of review, which can be either for a Product or Category.
language string, required The language of the review, represented as a two-letter code (e.g., en for English).
storeId string, optional The store where the review applies. If left empty, it will apply globally.
recordId string, required The unique identifier of the product or category to which the review belongs.
created string, required The date and time the review was created in ISO 8601 format.
updated string, required The date and time the review was last updated in ISO 8601 format.
archived boolean, optional Indicates whether the review is archived. Defaults to false.
fields array of objects, required

List of fields associated with the review:

  • field (string, required): The field associated with the review content (e.g., "description").
  • textId (string, required): The unique identifier for the text associated with the review.
  • text (string, required): The review text content.
  • created (string, required): The date and time the field was created in ISO 8601 format.
  • updated (string, required): The date and time the field was last updated in ISO 8601 format.

Example API Request

//https://api-eu.writetext.ai/text/Review

Response

200
400
404
500
//The review is successfully added or updated.
//This error occurs when the request body is incorrectly formatted or required fields are missing.
//This error occurs if the requested resource (e.g., review, product, or category) cannot be found.
//The server encountered an error when processing the request.