List custom email templates for a portal

List custom email templates

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A list of customized email templates used in a portal.

* Additional properties are NOT allowed.
dataarray[object]
Show Child Parameters
get/portals/{portalId}/email-templates
 
application/json

Get custom email template used in a portal

Get custom email template

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

templateNamestringrequired

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

Successful Retrieval for a portal email template.

EmailTemplate

labelstringrequired

The label of the email template

Example:App registration approved

namestringrequired

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

default_contentobjectrequired
Show Child Parameters
contentobject | null
Show Child Parameters
variablesarray[string]required

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

enabledbooleanrequired

Whether the email template is enabled or disabled for a portal

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/portals/{portalId}/email-templates/{templateName}
 
application/json

Update custom email template for a portal

Update custom email template

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

templateNamestringrequired

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

Update a custom portal email template.

contentobject | null
Show Child Parameters
enabledboolean

Whether the email template is enabled or disabled for a portal

Default:true

Response

application/json

Modifying an email template.

EmailTemplate

labelstringrequired

The label of the email template

Example:App registration approved

namestringrequired

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

default_contentobjectrequired
Show Child Parameters
contentobject | null
Show Child Parameters
variablesarray[string]required

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

enabledbooleanrequired

Whether the email template is enabled or disabled for a portal

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

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

Body

{ "enabled": true }
 
application/json

Delete custom email template

Delete custom email template for a portal. This will revert to using the default template

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

templateNamestringrequired

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

No Content

delete/portals/{portalId}/email-templates/{templateName}
 

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.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

templateNamestringrequired

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

Send a test email using a custom email template.

contentobjectrequired
Show Child Parameters

Response

No Content

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

Body

{ "content": { "subject": "{{developer_fullname}}, Your registration has been revoked", "title": "Revoked registration", "body": "Hello {{ developer_fullname }},\\n\\your registration has been **revoked**.", "button_label": "Acknowledge" } }