Sign in
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

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

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

Response

Successful Response

enabledboolean
providerstring
from_emailstring
sendgrid_api_keystring
ses_access_key_idstring
ses_secret_access_keystring
ses_regionstring
mass_rate_per_minuteinteger

Changes

No recorded changes to this endpoint across all 5 revisions of this API.