Portal Emails

Send Test Email

Changed on

Send a test email based on the portal's email template, using the content provided in the request. The email will be sent to the Konnect user who triggered the test.

post/v3/portals/{portalId}/email-templates/{templateName}/send-test-email

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/email-templates/{templateName}/send-test-email
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

portalIdstring uuid required
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

templateName'confirm-email-address' | 'app-registration-approved' | 'app-registration-rejected' | 'app-registration-revoked' | 'reset-password' | 'account-access-approved' | 'account-access-rejected' | 'account-access-revoked' | 'api-key-expiring-soon' | 'api-key-expired' | 'developer-invitation' required

Short name email template name.

Name of the email template.

Request body

Response

No Content

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status