Setup the email config for a portal
Setup the email config for a portal
Path Parameters
ID of the portal.
Body
application/json
Body
Update a portal email configured.
PatchPortalEmailConfig
The domain name to use for sending emails. Null means default.
The name to display in the ‘From’ field of emails.
The email address to use in the ‘From’ field.
The email address to use in the ‘Reply-To’ field. If set to null, ‘Reply-To’ header is omitted.
Response
application/json
Response
Portal email config.
PortalEmailConfig
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The domain name used for sending emails. Null means default.
The name displayed in the ‘From’ field of emails.
The email address used in the ‘From’ field.
The email address used in the ‘Reply-To’ field. ‘Reply-To’ header is omitted when null.
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 portal email config
Delete portal email config
Path Parameters
ID of the portal.
Response
Response
No Content
Authentication
Path Parameters
List default email templates
List default email templates
Response
application/json
Response
A list of the default email templates in a portal. This is a static list that will always be populated.
Show Child Parameters
Authentication
List email template variables
List email template variables
Response
application/json
Response
Successful response of usable variables for use in portal email templates.
EmailTemplateVariablesList
Show Child Parameters
Authentication
Get default email template
Get default email template
Path Parameters
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
Details about a default email template.
DefaultEmailTemplate
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
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
The label of the email template
Example:Confirm email Address