Skip to content

Delete review

Deletes the customer's review.

Needs the review:write scope.

Call

  • Tool: delete_review
  • Scope: review:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [
    "product"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
deleted true Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close