Skip to content

Client API

Submit a review from a browser

POSThttps://email.growthdept.ai/client/reviews

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.

Authentication

The account's public key in company_id. No private key and no scopes.

Operation id

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

Query parameters

stringrequired

The account's public key.

Body

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

object

  • dataobjectrequired

    data: 3 fields
    • typestringrequired

      review
    • attributesobjectrequired

      attributes: 10 fields
      • review_typestringrequired

        questionratingreviewstore
      • emailstring (email)required

      • authorstringrequired

      • contentstringrequired

      • incentive_typestring

      • productobject

        product: 2 fields
        • external_idstringrequired

        • integration_keystringrequired

          shopifywoocommerce
      • ratingobject

      • titlestring

      • custom_questionsarray of objects

        custom_questions: 2 fields
        • idstringrequired

        • answersarray of stringsrequired

      • imagesarray of strings

    • relationshipsobject

      relationships: 1 field
      • orderobject

        order: 1 field
        • dataobjectrequired

          data: 2 fields
          • typestringrequired

            order
          • idstringrequired

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

202Success

No body.

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