How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Email configuration API

Transports supports configuration of the tenant-level SMTP service. For the SMTP service in Qlik Automate, review the automation-connections API.

Qlik Email configuration API is one of 82 APIs that Qlik Sense APIs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Business Intelligence, Data Integration, and REST. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 7 operations across 4 paths, organized into 2 resource areas, and defines 19 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com.

7 operations 4 paths 19 schemas 1 DELETE1 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://{tenant}.{region}.qlikcloud.com/api/v1/transports/email-config
Resource Areas
2

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 1 GET, 1 PATCH, 3 POST, 1 PUT. They span 2 resource areas: email-config, email-config-actions. Each is listed below with its method, path, parameters, and response codes.

email-config 4
GET
/api/v1/transports/email-config
Get email configuration
getEmailConfig → 200403default
PATCH
/api/v1/transports/email-config
Patch email configuration
patchEmailConfig body → 204400403default
PUT
/api/v1/transports/email-config
Update email configuration
putEmailConfig body → 204400403default
DELETE
/api/v1/transports/email-config
Delete email configuration
deleteEmailConfig → 204403404default
email-config-actions 3
POST
/api/v1/transports/email-config/actions/send-test-email
Send test email
sendTestEmailAction body → 200403404default
POST
/api/v1/transports/email-config/actions/validate
Get configuration status
validateAction → 200default
POST
/api/v1/transports/email-config/actions/verify-connection
Verify configuration
verifyConnectionAction → 200404default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are getEmailConfig (15 properties), putBasicAuthConfig (7 properties), getBasicAuthConfig (6 properties), smtpResult (4 properties). Each schema is shown below with its type and property counts.

DeleteConfigNotFoundError
object
1 property
email
object
3 properties
emailConfigFieldPatch
object
A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
3 properties 3 required
emailConfigPatch
array
ErrorPublic
object
An error object.
2 properties 2 required
ErrorsPublic
object
1 property
getBasicAuthConfig
object
6 properties
getEmailConfig
object
15 properties
getMicrosoft365Config
object
3 properties
putBasicAuthConfig
object
SMTP basic authentication configuration. Provides server address, credentials, and sender information for standard SMTP email delivery.
7 properties
putEmailConfig
object
2 properties
putMicrosoft365Config
object
Microsoft 365 authentication configuration. Provides OAuth credentials and tenant information for Microsoft 365 email delivery.
4 properties
SendTestMailConfigNotFoundError
object
1 property
smtpCheck
object
2 properties
smtpConfigStatus
object
Contains statusCode and statusReason
2 properties
smtpResult
object
4 properties
TenantAdminError
object
1 property
UpdateEmailConfigError
object
1 property
VerifyConnectionConfigNotFoundError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-transports.json Raw ↑

Other APIs Qlik Sense APIs publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Apps API
Qlik Change stores API
Qlik Adaptive cards API
Qlik ODAG apps API
Qlik ODAG links API
Qlik ODAG requests API
Qlik ODAG settings API
Qlik API keys API
Where this information came from

This is an independent, third-party profile of Qlik Email configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.