Skip to content

Reviews API

Change a review's status

PATCHhttps://email.growthdept.ai/api/reviews/{id}

The request body can be up to 5 MB.

Rate limits

Burst: 10/s

Steady: 150/m

Tier M. See rate limits for how requests are counted.

Scopes

reviews:write

Operation id

update_review The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes of review resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 3 fields
    • typestringrequired

      review
    • idstringrequired

    • attributesobjectrequired

      attributes: 1 field
      • statusobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      review
    • idstringrequired

    • attributesobjectrequired

      attributes: 14 fields
      • emailstringcan be null

      • statusone ofcan be null

        One option: ReviewStatusRejected
        • valuestringrequired

          rejected
        • rejection_reasonone ofrequired

          One option: RejectReasonOther
          • reasonstringrequired

            other
          • status_explanationstringcan be null

          One option: RejectReasonFake
          • reasonstringrequired

            fake
          One option: RejectReasonMisleading
          • reasonstringrequired

            false_or_misleading
          One option: RejectReasonPrivateInformation
          • reasonstringrequired

            private_information
          One option: RejectReasonProfanity
          • reasonstringrequired

            profanity_or_inappropriate
          One option: RejectReasonUnrelated
          • reasonstringrequired

            unrelated
        One option: ReviewStatusFeatured
        • valuestringrequired

          featured
        One option: ReviewStatusPublished
        • valuestringrequired

          published
        One option: ReviewStatusUnpublished
        • valuestringrequired

          unpublished
        One option: ReviewStatusPending
        • valuestringrequired

          pending
      • verifiedbooleanrequired

      • review_typestringrequired

        questionratingreviewstore
      • createdstring (date-time)required

      • updatedstring (date-time)required

      • imagesarray of stringsrequired

      • productobjectcan be null

        product: 4 fields
        • urlstringrequired

        • namestringrequired

        • image_urlstringcan be null

        • external_idstringcan be null

      • ratingintegercan be null

      • authorstringcan be null

      • contentstringcan be null

      • titlestringcan be null

      • smart_quotestringcan be null

      • public_replyobjectcan be null

        public_reply: 3 fields
        • contentstringrequired

        • authorstringrequired

        • updatedstring (date-time)required

    • relationshipsobject

      relationships: 2 fields
      • eventsobject

        events: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            event
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • itemobject

        item: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            catalog-item
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject