Skip to content
View as Markdown

GET Auto Subscribe Settings​

GET
/setting/auto_subscribe_settings

Retrieve auto-subscribe settings for user registration, comments, user syncing, and role-based tagging. Optionally includes form field definitions. When WooCommerce is active, also returns checkout form subscribe settings.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Query Parameters

with[]

Include additional data. Use fields to include form field definitions for the settings UI.

Type
array

Responses​

Auto-subscribe settings for all subscription sources.

application/json
JSON
{
"registration_setting": {
},
"comment_settings": {
},
"user_syncing_settings": {
},
"role_based_tagging_settings": {
},
"registration_fields": {
},
"comment_fields": {
},
"user_syncing_fields": {
},
"role_based_tagging_settings_fields": {
},
"woo_checkout_fields": {
},
"woo_checkout_settings": {
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI