Skip to main content
PUT
Update the tenant's email sender configuration
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

PUT /tenant/email-settings Description: Updates sender (requires a verified email domain; senderEmail must use that domain). Returns the full updated settings (same shape as GET /tenant/email-settings). branding is no longer accepted here. Sending a branding key — even one that used to be always-available, like replyTo — returns 400 BRANDING_NOT_ALLOWED_HERE. Use PUT /capabilities/email-branding ({ "settings": { ... } }). There is no deprecation window. Authorization:
  • Required role: admin or higher
Method: PUT

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json

Provide sender, which requires a verified email domain. A branding key is rejected with 400 BRANDING_NOT_ALLOWED_HERE — use PUT /capabilities/email-branding instead.

sender
object

Requires the tenant's email domain to be verified.

Response

Email settings updated

No branding key. Email branding is read separately from GET /capabilities/email-branding.

status
string
Example:

"success"

data
object