You can customize both the email domain and content of emails that developers receive for the following events:
- Welcome (developer sign-up approved)
- App registration approved
- App registration rejected
- App registration revoked
- API key expired
- API key expiring soon
- Confirm email address
- Reset password
- Account access rejected
- Account access revoked
To configure email customization settings, go to your Dev Portal, click Portal Editor, and then click the Email icon in the sidebar.
In the customization settings, you can use variables. For example, {{application_name}} will be replaced with the name of the application in the email.
The following table contains the variables you can use when customizing emails:
|
Variable
|
Description
|
{{api_documentation_url}}
|
The documentation URL for the API.
|
{{api_name}}
|
The name of the API.
|
{{api_version}}
|
The version of the API.
|
{{application_name}}
|
The name of the developer’s application.
|
{{credential_name}}
|
The name of the key auth credential.
|
{{credential_expires_at}}
|
The date when the key auth credential expires.
|
{{dev_portal_reply_to}}
|
The Dev Portal reply-to email address.
|
{{developer_email}}
|
The email address of the developer.
|
{{developer_fullname}}
|
The full name of the developer.
|
{{developer_status}}
|
The Dev Portal status of a developer. For example, "approved", "pending", or "revoked".
|
{{portal_display_name}}
|
The display name of the Dev Portal.
|
{{portal_domain}}
|
The URL of the Dev Portal.
|
If you want to change the from and reply-to email domains, you can configure a different domain through Dev Portal settings.
Navigate to your Dev Portal, click Settings in the sidebar and click the Custom domains tab. Click New email domain and configure the settings.
After you’ve added your new domain, you must add the CNAME records to your DNS server.
Certain domain names are restricted. See Domain name restrictions for more information.