Settings API

Last updated: March 27, 2026

Get Settings

GET /api/v1/store/review-settings

{
  "settings": {
    "collection_enabled": false,
    "default_experience": "chat",
    "auto_approve_verified_buyer": false,
    "auto_approve_email_verified": false,
    "auto_approve_high_quality": false,
    "auto_approve_quality_threshold": 7,
    "review_request_delay_days": 7,
    "digest_enabled": false,
    "digest_recipient_email": null
  }
}

Update Settings

PUT /api/v1/store/review-settings

Pass only the settings you want to change.

{
  "settings": {
    "collection_enabled": true,
    "review_request_delay_days": 5
  }
}

Setting Reference

SettingTypeDefaultDescription
collection_enabledbooleanfalseWhen true, order fulfillments automatically create review requests.
default_experiencestring"chat"chat (AI-guided conversation) or form (simple star + text).
auto_approve_verified_buyerbooleanfalseAuto-approve reviews from verified buyers.
auto_approve_email_verifiedbooleanfalseAuto-approve reviews with verified email.
auto_approve_high_qualitybooleanfalseAuto-approve reviews above quality threshold.
auto_approve_quality_thresholdinteger7Quality score threshold (1-10). Only applies when auto_approve_high_quality is true.
review_request_delay_daysinteger7Days after fulfillment before sending review request email.
digest_enabledbooleanfalseWeekly digest email with review stats.
digest_recipient_emailstringnullOverride email for digest (defaults to store owner).

Example Configurations

Manual only (no automation)

{
  "settings": {
    "collection_enabled": false,
    "digest_enabled": false
  }
}

Use /review-requests/send with skip_email: true to create links manually.

Fully automated

{
  "settings": {
    "collection_enabled": true,
    "review_request_delay_days": 7,
    "auto_approve_verified_buyer": true,
    "auto_approve_high_quality": true,
    "auto_approve_quality_threshold": 7,
    "digest_enabled": true
  }
}

Automated collection, manual moderation

{
  "settings": {
    "collection_enabled": true,
    "review_request_delay_days": 5,
    "auto_approve_verified_buyer": false,
    "digest_enabled": true
  }
}