Setup the email config for a portal

Setup the email config for a portal

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Update a portal email configured.

PatchPortalEmailConfig

* Additional properties are NOT allowed.
domain_namestring | null

The domain name to use for sending emails. Null means default.

from_namestring | null

The name to display in the ‘From’ field of emails.

from_emailstring | null(email)

The email address to use in the ‘From’ field.

reply_to_emailstring | null(email)

The email address to use in the ‘Reply-To’ field. If set to null, ‘Reply-To’ header is omitted.

Response

application/json

Portal email config.

PortalEmailConfig

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

domain_namestring | null

The domain name used for sending emails. Null means default.

from_namestring | nullrequired

The name displayed in the ‘From’ field of emails.

from_emailstring | null(email)required

The email address used in the ‘From’ field.

reply_to_emailstring | null(email)required

The email address used in the ‘Reply-To’ field. ‘Reply-To’ header is omitted when null.

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-config

Body

{ "domain_name": "example.com", "from_name": "Gandalf", "from_email": "user@example.com", "reply_to_email": "admin@example.com" }
 
application/json

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