Settings API

Read and update global plugin settings, per-platform advanced settings, license, translation strings, and destructive data-reset operations. Handler: SettingsController.

Base URL: https://your-site.com/wp-json/wpsocialreviews/v2

Policy: SettingsPolicy

---

Platform Advanced Settings

GET /settings · PUT /settings

Read or save a platform's advanced settings.

Handlers: @index / @update

GET parameters

Parameter	Type	Location	Required	Description
platform	string	query	Yes	Platform slug (returns false for unavailable WooCommerce/TikTok)

PUT parameters

Parameter	Type	Location	Required	Description
platform	string	body	Yes	Platform slug
settings	object (JSON)	body	Yes	e.g. manually_review_approved, auto_syncing, expiration, hide_reviews_count, selected_template, optimized_images, is_enabled_platform

update fires save_advance_settings_{platform}; the platform handler persists and responds.

---

Clear Cache

DELETE /settings

Clear a platform's (or template's) cache.

Handler: @delete

Parameter	Type	Location	Required	Description
platform	string	body	Yes	Platform slug
cacheType	string	body	No	Which cache to clear
templateId	integer	body	No	Limit to a template

---

License

Core exposes these as pass-throughs to the wpsr_*_license filters (fulfilled by Pro).

Method	Endpoint	Handler	Response
GET	/settings/license	@getLicense	filter result, or 422
POST	/settings/license	@addLicense	filter result, or 422
DELETE	/settings/license	@removeLicense	filter result, or 422

The whole request is passed to the filter, so include whatever the license service expects (e.g. license_key).

---

Translations

Method	Endpoint	Handler	Inputs	Response
GET	/settings/translations	@getTranslations	—	{ "message": "success", "translations_settings": {} }
POST	/settings/translations	@saveTranslations	translations_settings (JSON)	{ "message" }

---

Global Advanced Settings

GET /settings/advance-settings · POST /settings/advance-settings

Handlers: @getAdvanceSettings / @saveAdvanceSettings

GET response

{
  "message": "success",
  "advance_settings": {},
  "ai_summarizer_settings_options": {}
}

POST parameters

Parameter	Type	Location	Required	Description
advance_settings	object (JSON)	body	Yes	has_gdpr, optimize_image_format, review_optimized_images, preserve_plugin_data, ai_review_summarizer_enabled, ai_platform, ai_api_key, selected_model, email_report{status,sending_day,recipients}, qr_codes[]

The ai_api_key is encrypted before storage. Returns { "message": "..." }.

---

Twitter Card & Data Reset

Method	Endpoint	Handler	Response
DELETE	/settings/twitter-card	@deleteTwitterCard	{ "success", "message" }
DELETE	/settings/reset-images	@resetData (input platform)	{ "message": "Images reset successfully!" }
DELETE	/settings/reset-error-log	@resetErrorLog	{ "message" }
DELETE	/settings/delete-all-data	@deleteAllData	{ "message" }

Destructive

delete-all-data removes all plugin data (an uninstall). Guard any tooling that calls it.

---

Review-Collection QR Codes

Route lives under pro/settings

These QR-code endpoints are registered under the pro/settings prefix (see the Pro API) but are handled by the core SettingsController. They are documented here because that's where the handler lives.

Method	Endpoint	Handler	Inputs	Response
GET	/pro/settings/get-reviews/qr-code	@getReviewCollectionQrCodes	—	{ "message", "data": [] }
POST	/pro/settings/get-reviews/qr-code	@createReviewCollectionQrCode	name, collection_form, custom_url	{ "message", "data" }
PUT	/pro/settings/get-reviews/qr-code/{id}	@updateReviewCollectionQrCode	path {id}, name, collection_form, custom_url	{ "message", "data" } (or 404/400)
DELETE	/pro/settings/get-reviews/qr-code/{id}	@deleteReviewCollectionQrCode	path {id}	{ "message" }
GET	/pro/settings/get-reviews/get-review-collection-platforms	@getReviewCollectionPlatforms	—	{ "message", "data" }