Skip to main content
POST
/
v2
/
reviews
/
{platform}
cURL
curl --request POST \
  --url https://api.loyaltylion.com/v2/reviews/{platform} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant_id": "<string>",
  "status": "approved",
  "full_text": "<string>",
  "rating": 2,
  "images_count": 500,
  "videos_count": 500,
  "site_id": 2,
  "moderation_url": "<string>"
}
'
{
  "review": {
    "id": 123,
    "program_id": 123,
    "site_id": 123,
    "platform": "custom",
    "merchant_id": "<string>",
    "status": "approved",
    "full_text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit",
    "rating": 5,
    "images_count": 3,
    "videos_count": 0,
    "moderation_url": "<string>"
  }
}
This endpoint is in preview, and is only available to partners and merchants who have opted-in
Use this endpoint to create a review in LoyaltyLion. When a review is created, if an applicable rule exists, it will be triggered based on the review’s status. If you are a review platform partner, use your platform identifier as the platform parameter. If you are a merchant integrating a custom reviews app, use custom.

Authorizations

​
Authorization
string
header
required

An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer token in the Authorization header

Path Parameters

​
platform
string
required

The review platform. Use your platform identifier if you are a review partner, or "custom" if you are a merchant integrating a custom reviews app

Minimum string length: 1
Example:

"custom"

Body

application/json

Body

​
merchant_id
string
required

The ID of the review in the review platform

Minimum string length: 1
​
status
enum<string>
required

The current status of the review, which determines how and when associated rules are triggered. One of: pending (the review is pending review), flagged (the review has been flagged for review), approved (the review has been approved/published), rejected (the review has been rejected)

Available options:
approved,
flagged,
pending,
rejected
​
full_text
string
required

The full text of the review

Minimum string length: 1
​
rating
number
required

The rating given in the review

Required range: x >= 1
​
images_count
number
required

The number of images attached to the review

Required range: 0 <= x <= 1000
​
videos_count
number
required

The number of videos attached to the review

Required range: 0 <= x <= 1000
​
site_id
number | null

Optional LoyaltyLion site ID this review belongs to

Required range: x >= 1
​
moderation_url
string<uri> | null

Optional URL to moderate the review in the review platform

Response

201

​
review
object
required