Portal Emails

Update custom email template for a portal

Changed on

Update custom email template

patch/v3/portals/{portalId}/email-templates/{templateName}

Request

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

Request body

enabledboolean

Whether the email template is enabled or disabled for a portal

Response

Modifying an email template.

labelstring required

The label of the email template

name'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.

variablesEmailTemplateVariableName[] required
enabledboolean required

Whether the email template is enabled or disabled for a portal

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "label": "App registration approved",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

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