Flag a review for removal

Report a review to the site it's on as fake, inappropriate, or against that site's rules, and track what happens.

Report a review to the site it's on as fake, inappropriate, or against that site's rules, and track what happens.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
POSTFlag a reviewSubmit (or re-submits, while still pending) a flag against the review identified by the URL {id}, persisting a ReviewFlag row with status pending, writing an audit log and a per-review history event, and consuming the review_flag plan-feature quota.
GETCheck a flag's statusGet the current flag on a review, or a none state when the review has never been flagged.
GETSee flag historyPaginated list of review flags whose review belongs to a store the authenticated user can access, newest flag first.
GETGet the reasons a site acceptsGet the flag-reason catalog used by the flagging dropdown.