Sign in

v1

latestOpenAPI 3.0.02026-07-24283460.8 KB
Legacy
Product Review Invitations

Queue Product invitation

post/product/invitation

Query parameters

storestring required

Your REVIEWS.io public store key

apikeystring required

Your REVIEWS.io private api key

Request body

namestring

Customer Name

emailstring

Customer Email Address

order_idstring

Customer Order Reference

template_idstring

Invitation email template id

phonestring

Customers mobile phone number

date_sendstring

Time email to be sent

country_codestring

Alpha-2 country code of customer

branchstring

The branch name

Example request

{
  "name": "Customer",
  "email": "customer@website.com",
  "order_id": "#12345",
  "template_id": "#12345",
  "phone": "+44 7522 143154",
  "date_send": "2023-10-27 10:30:45",
  "country_code": "NL",
  "branch": "My Store - South London Branch",
  "products": [
    {
      "sku": "PR-123",
      "name": "Large T-Shirt in black",
      "imageUrl": "https://website.com/media/t-shirt-black.png",
      "pageUrl": "https://website.com/products/t-shirt-black",
      "gtin": "00001112234",
      "mpn": "TSHIRT001",
      "description": "description",
      "category": "t-shirts",
      "lookup": "reviewsio-tshirt"
    }
  ]
}

Response

OK

successstring

If the request succeeded

idinteger

The ID of the Invitation (if queued)

messagestring

Plaintext information on whether an Invitation was queued or not.

Example response

{
  "success": "true",
  "messages": ""
}