Company Review Invitations

Queue Company SMS Invitation

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

Customers name

customer_emailstring

Customers email address

order_idstring

Customers order reference

mobile_numberstring

Customers phone number, in E.164 format

date_sendstring

Time SMS to be sent

Example request

{
  "customer_name": "Gerald",
  "customer_email": "gerald@reviews.io",
  "order_id": "#1234",
  "mobile_number": "+44780000000",
  "date_send": "2023-10-27 10:30:45"
}

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.