REreviews
Product Review Invitations

Queue Product SMS Invitation

post/product/sms/invitation

Request

Query parameters

storestring required

Your REVIEWS.io public store key

apikeystring required

Your REVIEWS.io private api key

Request body raw

customer_namestring required

Customers name

mobile_numberstring required

Customers phone number, in E.164 format

order_idstring required

Customers order reference

messagestring

Customize the message text. Placeholders: [name] [DomainName] [link]

Example request

{
  "customer_name": "Gerald",
  "mobile_number": "+44780000000",
  "order_id": "#1234",
  "message": "Hi, thanks for choosing [DomainName]! We'd love to hear what you thought [link].",
  "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

messagestring

Plaintext information on whether an Invitation was queued or not.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.