API Docs / Operations / Email Configs / Update Email Config

Update Email Config

PUT /tenants/{tenant}/email-configs/{code}

Changes the sender, the SMTP settings or which connection is the default; a property left out keeps its value, a password left out keeps the stored one. The default is changed by making another connection the default.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

code* path string

Request Body*

{
  "fromEmail": "user@example.com",
  "fromName": "string",
  "isDefault": false,
  "smtpSettings": {
    "host": "string",
    "port": 1,
    "encryption": "...",
    "requiresAuthentication": false,
    "username": "string"
  }
}

Responses

400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
404 Not Found
application/problem+json