API Docs / Operations / Email Configs / Create Email Config

Create Email Config

POST /tenants/{tenant}/email-configs

Adds a connection, send only. SMTP takes smtpSettings. Outlook and Gmail take returnUrl and come back awaiting sign-in, with the authorisationUrl to send the user to; the sign-in returns to returnUrl with oauth_status, config_code and oauth_error in its query. The tenant's first connection is its default.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

Request Body*

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

Responses

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