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

Kong Portal Emails API

APIs related to Konnect Developer Portal Emails.

Kong Portal Emails API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Portal Emails. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 19 operations across 10 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

19 operations 10 paths 39 schemas 4 DELETE9 GET3 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Portal Emails API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

Paths & Operations 19

Across 10 paths, the API surfaces 19 operations — 4 DELETE, 9 GET, 3 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Portal Emails 19

APIs related to Konnect Developer Portal Emails.

GET
/v3/portals/{portalId}/email-config
Get the email config for the portal
get-email-config 1 param → 200401403404
POST
/v3/portals/{portalId}/email-config
Create the email config for a portal
create-portal-email-config 1 param body → 201400401403404409
PATCH
/v3/portals/{portalId}/email-config
Setup the email config for a portal
update-portal-email-config 1 param body → 200400401403404
DELETE
/v3/portals/{portalId}/email-config
Delete portal email config
delete-portal-email-config 1 param → 204401403404
GET
/v3/portals/{portalId}/email-deliverydeprecated
Get the email delivery for the portal
get-email-delivery 1 param → 200401403404
PATCH
/v3/portals/{portalId}/email-deliverydeprecated
Setup the email delivery for a portal
update-email-delivery 1 param body → 200400401403404
DELETE
/v3/portals/{portalId}/email-deliverydeprecated
Delete email delivery
delete-email-delivery 1 param → 204401403404
GET
/v3/portals/{portalId}/email-templates
List custom email templates for a portal
list-portal-custom-email-templates 1 param → 200401403404
GET
/v3/portals/{portalId}/email-templates/{templateName}
Get custom email template used in a portal
get-portal-custom-email-template 2 params → 200401403404
PATCH
/v3/portals/{portalId}/email-templates/{templateName}
Update custom email template for a portal
update-portal-custom-email-template 2 params body → 200400401403404
DELETE
/v3/portals/{portalId}/email-templates/{templateName}
Delete custom email template
delete-portal-custom-email-template 2 params → 204401403404
POST
/v3/portals/{portalId}/email-templates/{templateName}/send-test-email
Send Test Email
post-portal-custom-email-test-send 2 params body → 204400401403404
GET
/v3/portals/email-domains
List email domains
list-email-domains 4 params → 200401403
POST
/v3/portals/email-domains
Create an email domain
create-email-domain body → 201400401403404
GET
/v3/portals/email-domains/{emailDomain}
Get an email domain
get-email-domain 1 param → 200401403404
DELETE
/v3/portals/email-domains/{emailDomain}
Delete an email domain
delete-email-domain 1 param → 204401403404
GET
/v3/portals/email-templates
List default email templates
list-default-email-templates → 200401403404
GET
/v3/portals/email-templates/{templateName}
Get default email template
get-default-email-template 1 param → 200401403404
GET
/v3/portals/email-templates/variables
List email template variables
list-email-template-variables → 200401403404

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are EmailTemplate (8 properties), PortalEmailConfig (7 properties), InvalidParameterMaximumLength (5 properties), InvalidParameterDependentItem (5 properties). Each schema is shown below with its type and property counts.

BaseError
object
standard error
5 properties 4 required
BadRequestError
InvalidParameterMinimumLength
object
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
DefaultEmailTemplateContent
object
4 properties 3 required
EmailTemplateVariablesList
object
1 property
PatchPortalEmailConfig
object
4 properties
PaginatedMeta
object
returns the pagination information
1 property 1 required
EmailVerificationStatus
string
Specifies the status of the mail domain verification
EmailTemplateVariableName
string
Enum for available portal email template variables.
NotFoundError
UnauthorizedError
SendTestEmailTemplateContent
object
4 properties 3 required
DefaultEmailTemplate
object
4 properties 4 required
EmailTemplateVariable
object
4 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
EmailDeliveryUpdatePayload
object
3 properties
PortalEmailConfig
object
7 properties 6 required
InvalidParameterStandard
object
4 properties 2 required
EmailDomainVerification
object
3 properties 3 required
EmailTemplateName
string
Short name email template name.
InvalidParameterChoiceItem
object
5 properties 4 required
EmailDelivery
object
5 properties 5 required
InvalidParameters
array
invalid parameters
EmailDomainFilterParameters
object
2 properties
EmailTemplate
object
8 properties 7 required
DNSRecord
object
3 properties 3 required
ConflictError
ForbiddenError
EmailDomain
object
5 properties 5 required
PostPortalEmailConfig
object
4 properties
InvalidParameterDependentItem
object
5 properties 4 required
EmailDomainPayload
object
1 property 1 required
ListDomains
object
2 properties 2 required
InvalidRules
string
invalid parameters rules
EmailTemplateContent
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-portal-emails-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API
Where this information came from

This is an independent, third-party profile of Kong Portal Emails 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.