PUT
/settingsUpdate server settings
Updates settings stored in the database. Supply the settings fields you want to update; each listed field is optional.
Optional settings values to update. All listed fields are optional.
app.site_namestringoptional
The site's name.
app.root_urlstringoptional
The root URL of the application.
app.logo_urlstringoptional
The URL of the application logo.
app.favicon_urlstringoptional
The URL of the application favicon.
app.from_emailstringoptional
The email address used as the sender address.
app.notify_emailsarray<string>optional
Email addresses that receive notifications.
app.enable_public_subscription_pagebooleanoptional
Whether to enable the public subscription page.
app.enable_public_archivebooleanoptional
Whether to enable the public archive.
app.send_optin_confirmationbooleanoptional
Whether to send opt-in confirmation messages.
app.check_updatesbooleanoptional
Whether to check for updates.
app.langstringoptional
The application language.
app.batch_sizeintegeroptional
The number of items processed in a batch.
app.concurrencyintegeroptional
The number of concurrent operations.
app.max_send_errorsintegeroptional
The maximum number of send errors.
app.message_rateintegeroptional
The message sending rate.
app.message_sliding_windowbooleanoptional
app.message_sliding_window_durationstringoptional
app.message_sliding_window_rateintegeroptional
privacy.individual_trackingbooleanoptional
privacy.unsubscribe_headerbooleanoptional
privacy.allow_blocklistbooleanoptional
privacy.allow_preferencesbooleanoptional
privacy.allow_exportbooleanoptional
privacy.allow_wipebooleanoptional
privacy.exportablearray<string>optional
privacy.domain_blocklistarray<object>optional
upload.providerstringoptional
upload.filesystem.upload_pathstringoptional
upload.filesystem.upload_uristringoptional
upload.s3.urlstringoptional
upload.s3.public_urlstringoptional
upload.s3.aws_access_key_idstringoptional
upload.s3.aws_default_regionstringoptional
upload.s3.bucketstringoptional
upload.s3.bucket_domainstringoptional
upload.s3.bucket_pathstringoptional
upload.s3.bucket_typestringoptional
upload.s3.expirystringoptional
smtparray<object>optional
messengersarray<object>optional
bounce.enabledbooleanoptional
bounce.webhooks_enabledbooleanoptional
bounce.countintegeroptional
bounce.actionstringoptional
bounce.ses_enabledbooleanoptional
bounce.azure.enabledbooleanoptional
bounce.azure.shared_secretstringoptional
bounce.azure.shared_secret_headerstringoptional
bounce.sendgrid_enabledbooleanoptional
bounce.sendgrid_keystringoptional
bounce.forwardemail_enabledbooleanoptional
bounce.forwardemail_keystringoptional
bounce.postmark_enabledbooleanoptional
bounce.postmark_usernamestringoptional
bounce.postmark_passwordstringoptional
bounce.mailboxesarray<object>optional
appearance.admin.custom_cssstringoptional
appearance.admin.custom_jsstringoptional
appearance.public.custom_cssstringoptional
appearance.public.custom_jsstringoptional
200Returns a boolean `data` value indicating the settings update result.
databooleanoptional
Error handling
Each supplied setting must match its declared type: for example, app.site_name is a string, app.notify_emails is an array of strings, and app.enable_public_archive is a boolean.