Generated by API Evangelist
Written by API Evangelist tooling for Qlik Sense's API. It is a proposal applied on top of the contract, not a document Qlik Sense publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for transports Email Config Actions API
version: 1.0.0
extends: openapi/qliksense-email-config-actions-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/api/v1/transports/email-config/actions/send-test-email'].post
update:
x-apievangelist-phrasing:
intent: Send a test email
effect: write
questions:
- How can I confirm my tenant's email setup actually delivers mail?
- Can I choose the subject and body of a test email?
instructions:
- text: Send a test email to {recipient}.
slots:
recipient: requestBody.recipient
- text: Send a test email to {recipient} with subject {subject} and body {body}.
slots:
recipient: requestBody.recipient
subject: requestBody.subject
body: requestBody.body
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/transports/email-config/actions/validate'].post
update:
x-apievangelist-phrasing:
intent: Check whether the email config is valid
effect: read
questions:
- Is my saved email configuration marked valid, without contacting the server?
- What does the validity check return if no email configuration exists?
instructions:
- text: Check whether the tenant's email configuration is valid.
- text: Tell me if the saved email config is marked valid, without connecting to the server.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/transports/email-config/actions/verify-connection'].post
update:
x-apievangelist-phrasing:
intent: Verify the email server connection
effect: read
questions:
- Can I test that the mail server is reachable and the credentials work without sending an email?
- How do I verify SMTP connectivity for the tenant?
instructions:
- text: Verify the connection to the configured email server.
- text: Test that the mail server accepts our credentials without sending a message.
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.