Get custom email template used in a portal
Get custom email template
Path Parameters
ID of the portal.
Short name email template name.
Allowed values:confirm-email-addressapp-registration-approvedapp-registration-rejectedapp-registration-revokedreset-passwordaccount-access-approvedaccount-access-rejectedaccount-access-revokedapi-key-expiring-soonapi-key-expireddeveloper-invitation
Response
application/json
Response
Successful Retrieval for a portal email template.
EmailTemplate
The label of the email template
Example:App registration approved
Short name email template name.
Allowed values:confirm-email-addressapp-registration-approvedapp-registration-rejectedapp-registration-revokedreset-passwordaccount-access-approvedaccount-access-rejectedaccount-access-revokedapi-key-expiring-soonapi-key-expireddeveloper-invitation
Show Child Parameters
Show Child Parameters
Enum for available portal email template variables.
Allowed values:portal_display_nameportal_domaindeveloper_emaildeveloper_fullnamedev_portal_reply_todeveloper_statusapi_documentation_urlapi_nameapi_versionapplication_namecredential_namecredential_expires_at
Whether the email template is enabled or disabled for a portal
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update custom email template for a portal
Update custom email template
Path Parameters
ID of the portal.
Short name email template name.
Allowed values:confirm-email-addressapp-registration-approvedapp-registration-rejectedapp-registration-revokedreset-passwordaccount-access-approvedaccount-access-rejectedaccount-access-revokedapi-key-expiring-soonapi-key-expireddeveloper-invitation
Body
application/json
Body
Update a custom portal email template.
Show Child Parameters
Whether the email template is enabled or disabled for a portal
Default:true
Response
application/json
Response
Modifying an email template.
EmailTemplate
The label of the email template
Example:App registration approved
Short name email template name.
Allowed values:confirm-email-addressapp-registration-approvedapp-registration-rejectedapp-registration-revokedreset-passwordaccount-access-approvedaccount-access-rejectedaccount-access-revokedapi-key-expiring-soonapi-key-expireddeveloper-invitation
Show Child Parameters
Show Child Parameters
Enum for available portal email template variables.
Allowed values:portal_display_nameportal_domaindeveloper_emaildeveloper_fullnamedev_portal_reply_todeveloper_statusapi_documentation_urlapi_nameapi_versionapplication_namecredential_namecredential_expires_at
Whether the email template is enabled or disabled for a portal
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete custom email template
Delete custom email template for a portal. This will revert to using the default template
Path Parameters
ID of the portal.
Short name email template name.
Allowed values:confirm-email-addressapp-registration-approvedapp-registration-rejectedapp-registration-revokedreset-passwordaccount-access-approvedaccount-access-rejectedaccount-access-revokedapi-key-expiring-soonapi-key-expireddeveloper-invitation
Response
Response
No Content
Authentication
Path Parameters
Send Test Email
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.
Path Parameters
ID of the portal.
Short name email template name.
Allowed values:confirm-email-addressapp-registration-approvedapp-registration-rejectedapp-registration-revokedreset-passwordaccount-access-approvedaccount-access-rejectedaccount-access-revokedapi-key-expiring-soonapi-key-expireddeveloper-invitation
Body
application/json
Body
Send a test email using a custom email template.
Show Child Parameters
Response
Response
No Content
Authentication
Path Parameters
Body
Portals IP Allow List
APIs related to Konnect Portal IP Allow List.