Use the API to customize the sender domain in email notification addresses

This article is for developers with a full understanding of how to work with our API. 

Important note about the API explorer
When you follow the link we provide to the API explorer, you'll see a red warning.
API_image01.png
The API itself is not deprecated. It's the Google API explorer that is deprecated. All the processes described in our API articles function correctly and safely if you use this Google API explorer. 


Email notifications sent from AODocs use default addresses. Learn more: List of email notifications sent by AODocs.

Note: All emails sent by AODocs comply with standard email authentication methods

You can customize the sender addresses for email notifications. This can help users recognize the sender and context. Two custom configuration flags are available to change the default addresses for the whole domain or specific libraries. You can use the API to:

  • customize the sender domain in email notification addresses (that is, what comes after the @ sign), as described in this article
  • define a prefix in email notification addresses – the word notifications is replaced by the required prefix

Important:
– You can configure this custom configuration by API only. It isn't available in the administration interface.
– The API that lets you customize the sender domain in email notification addresses is a feature of the AODocs Document Management Platform, included in the AODocs Application Platform license level. Contact your AODocs sales representative or send an email to sales@aodocs.com
– Custom configurations at the library level take precedence over those set at the domain level. For example, if you set the sender domain flag as abc.com at the domain level and as xyz.com for one library, all the libraries on the domain will send notifications from xxx@abc.com except the one in which the flag is defined as xyz.com, which will send notifications from xxx@xyz.com.

Learn more: Use the API to check which custom configuration flags are set on your domain or library.

In this article:

Automatically generated table of contents


Prerequisites

Before using the API to customize the sender domain for your email notifications, contact the AODocs Support team by email at support@aodocs.com or open a ticket.

They will ask you to provide information such as the sender domain you want to use, your email provider and your API key. The AODocs Support team will perform the required configuration so you can use the API to customize the sender domain as defined below. 

Note: All email notification addresses are no-reply addresses. If required, you can add noreply in the address. If you do this, make sure you include it when you register the address with your email provider and when you indicate the sender domain to the AODocs Support team.  


Cusomize the sender domain in your email notification addresses at the domain level

1. As an AODocs super administrator, follow one of these links to the AODocs API:

  • US instance:

https://apis-explorer.appspot.com/apis-explorer/?base=https://ao-docs.appspot.com/api#s/domain/v1beta1/domain.configuration.set

  • EU instance:

https://apis-explorer.appspot.com/apis-explorer/?base=https://aodocs-core-eu-1.appspot.com/api#s/domain/v1beta1/domain.configuration.set 

Note: Dedicated instances have their own URLs. Learn more: What are AODocs instances?

2. Enter the flag name: emailSender.provider.name.

3. In the Request body field, enter the name of your email provider: MAILJET, MAILGUN, or SENDGRID.

4. Click Authorize and execute. The response is displayed in the lower part of the screen.

image01.png

5. Follow one of the links in step 1 again. 

6. Enter the flag name: emailSender.noreplyAddress.domain.

7. In the Request body field, enter the name of the domain you want to use.

8. Click Authorize and execute. The response is displayed in the lower part of the screen.

image01.png


Cusomize the sender domain in your email notification addresses at the library level

1. As a library administrator, follow one of these links to the AODocs API:

  • US instance:

https://apis-explorer.appspot.com/apis-explorer/?base=https://ao-docs.appspot.com/api#s/library/v1beta1/library.configuration.set

  • EU instance:

https://apis-explorer.appspot.com/apis-explorer/?base=https://aodocs-core-eu-1.appspot.com/api#s/library/v1beta1/library.configuration.set

Note: Dedicated instances have their own URLs. Learn more: What are AODocs instances?

2. Enter the ID of the library in which you want to activate the custom configuration. Learn how to identify library IDs.

3. Enter the flag name: emailSender.provider.name.

4. In the Request body field, enter the name of your email provider: MAILJET, MAILGUN, or SENDGRID.

5. Click Authorize and execute. The response is displayed in the lower part of the screen.

image03.png

6. Follow one of the links in step 1 again. 

7. Enter the flag name: emailSender.noreplyAddress.domain.

8. In the Request body field, enter the name of the domain you want to use.

9. Click Authorize and execute. The response is displayed in the lower part of the screen.

image02.png

Was this article helpful? 0 out of 0 found this helpful
If you didn’t find what you were looking for, don’t hesitate to leave a comment!
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.