Embeds
SMTP Settings
Configure SMTP settings for your data app so scheduled reports can be sent by email.
PUT
Set or update the SMTP configuration used to send scheduled reports and other emails for your data app. The API validates the connection before saving; if the credentials or server are invalid, the request fails and settings are not stored.
You can also configure email in the UI: Settings → Embed Settings → Email Settings. This API is for automation and integration. See Email Settings for Scheduled Reports for the UI flow.
Endpoint
Authentication
All requests must include your data app API key in theAuthorization header. See the data app creation guide and the API Token guide.
Headers
string
required
Bearer token for API authentication. Use your data app API key.
string
required
Must be
application/json.Request Body
string
required
SMTP server hostname (e.g.
smtp.example.com).number
required
SMTP server port as integer (e.g.
587 for STARTTLS, 465 for implicit SSL).string
required
SMTP authentication username.
string
required
SMTP authentication password.
string
required
Sender email address. Must be a valid email format (e.g.
noreply@example.com).string
required
Reply-to email address. Must be a valid email format.
boolean
required
Whether to use TLS/SSL for the connection. Use
true for port 465; use false for port 587 with STARTTLS.Response
Examples
Error codes
Related
Email Settings for Scheduled Reports
Configure email in the UI
Whitelist Domains
Manage embedding domains

