Delete portal email config

Delete portal email config

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

No Content

delete/portals/{portalId}/email-config
 

List default email templates

List default email templates

get

Response

application/json

A list of the default email templates in a portal. This is a static list that will always be populated.

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

List email template variables

List email template variables

get

Response

application/json

Successful response of usable variables for use in portal email templates.

EmailTemplateVariablesList

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

Get default email template

Get default email template

get

Path Parameters

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

Details about a default email template.

DefaultEmailTemplate

* Additional properties are NOT allowed.
default_contentobjectrequired
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

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

labelstringrequired

The label of the email template

Example:Confirm email Address

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

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