Set platform email provider configuration

Configures the platform-level email provider. Stores as a settings override in the internal database.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

provider*string

Email provider to use for platform email delivery.

Value in"resend" | "sendgrid" | "postmark" | "smtp" | "ses"

apiKey?string

Provider API key. Omit to keep existing key on update.

Length1 <= length

fromAddress?string

Sender address for platform emails.

curl -X PUT "http://localhost:3001/api/v1/admin/email-provider" \  -H "Content-Type: application/json" \  -d '{    "provider": "resend"  }'

{
  "config": {
    "provider": "resend",
    "fromAddress": "string",
    "apiKeyMasked": "string",
    "source": "override"
  }
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "property1": null,
  "property2": null
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}