Organization API: Organizations & Members: Reviews

Part of Organizations & Members.

GET /api/v1/orgs/{org_slug}/reviews

The Trustpilot review settings, and how the review invitation emails are doing.

Needs the Admin or Owner role. enabled is whether the storefront asks signed-in customers for a review, review_url the Trustpilot link it opens (null for none), min_account_age_days how old an account is before it asks, and dismiss_days how long it stays quiet after a customer closes the prompt. The invitation is the email flow review_invite, which uses the same link. invitations holds enabled (the flow's own switch), the number of its messages scheduled, sent, skipped and failed (all 0 until the flow has run) and last_sent_at.

PUT /api/v1/orgs/{org_slug}/reviews

Change the review settings. Send only what changes.

Needs the Admin or Owner role. review_url must start with https:// and be on trustpilot.com, at most 500 characters, and the prompt cannot be turned on without one. min_account_age_days is 0 to 365 and dismiss_days 1 to 365. A value that does not fit answers 422 with detail, the sentence to show, and field, the setting it belongs to. The answer is the one GET gives, with changed listing the settings that differ from before. Saving what is already saved changes nothing and writes no audit entry. A change is recorded as reviews.updated, and the storefront applies it to new page loads within a minute.

application/json (required)