Report a review for moderation
Flags a review as VULGAR, PERSONAL_DATA or OTHER. The review stays public until it has been checked;
a studio cannot remove a review. A second report replaces reason and note. Requires the orders:manage
scope and an Idempotency-Key header.
ApiKeyAuth orders:manageAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: orders:manage
id*stringIdempotency-Key*stringCaller-chosen idempotency token for this write. A retry under the SAME key with
the SAME body replays the first response; the SAME key with a DIFFERENT body is
422 IDEMPOTENCY_KEY_MISMATCH. See Idempotency above.
length <= 64application/json- body
reason*string"VULGAR""PERSONAL_DATA""OTHER"note?|At most 1500 characters. Optional.
The review with its report.
application/json- response
A review as the studio sees it - the public page plus the customer's full name and the order.
id?stringrating?integer1 <= value <= 5text?string|nullauthorName?stringThe shortened public name, e.g. "Jana N.".
customerFullName?stringFor the studio only.
services?array<string>visitDate?stringThe handover day in the studio's time zone.
datecreatedAt?stringdate-timeorderId?stringorderPublicId?stringreply?|nullreport?|nullcurl -X POST 'https://api.shyni.io/api/v1/reviews/string/report' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -H 'Content-Type: application/json' \ -d '{ "reason": "VULGAR"}'Response 200
The review with its report.
{ "id": "string", "rating": 1, "text": "string", "authorName": "string", "customerFullName": "string", "services": [ "string" ], "visitDate": "2019-08-24", "createdAt": "2019-08-24T14:15:22Z", "orderId": "string", "orderPublicId": "string", "reply": { "text": "string", "createdAt": "2019-08-24T14:15:22Z" }, "report": { "reason": "VULGAR", "note": "string", "createdAt": "2019-08-24T14:15:22Z" }}Response 400
A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.
{ "code": "INVALID_INPUT", "message": "Parameter perPage must be between 1 and 100."}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 404
The resource does not exist, or belongs to a different studio.
{ "code": "NOT_FOUND", "message": "Order not found."}Response 422
The same Idempotency-Key was already used for a request with a different body, use a new key (see Idempotency above).
{ "code": "IDEMPOTENCY_KEY_MISMATCH", "message": "This Idempotency-Key was already used for a different request. Use a new key."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}