Sign in

v1

latestOpenAPI 3.0.02026-07-24283460.8 KB
Legacy
Company Review Invitations

Queue Company Invitation

post/merchant/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

Example request

{
  "name": "Customer",
  "email": "customer@website.com",
  "order_id": "#12345",
  "template_id": "#12345"
}

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": ""
}