v2

latestOpenAPI 3.1.02026-07-26391214472.7 KB

email-settings

Update Email Settings

Update email settings for the current tenant (admin-only).

If a secret field contains the mask pattern ('****'), the existing value is preserved. Send a new full value to replace it.

put/api/v1/admin/email-settings

authorizationstring nullable

X-API-Keystring nullable

enabledboolean nullable

providerstring nullable

from_emailstring nullable

sendgrid_api_keystring nullable

ses_access_key_idstring nullable

ses_secret_access_keystring nullable

ses_regionstring nullable

mass_rate_per_minuteinteger nullable

Successful Response

enabledboolean

providerstring

from_emailstring

sendgrid_api_keystring

ses_access_key_idstring

ses_secret_access_keystring

ses_regionstring

mass_rate_per_minuteinteger