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.

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. 

In this article:

Automatically generated table of contents

What does the API call do?

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 use the API to customize the sender addresses for email notifications. This helps 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 [email]@abc.com except the one in which the flag is defined as xyz.com, which will send notifications from [email]@xyz.com.

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

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 the following information:

• your custom sender domain – for example, companyname.com

• the email provider you use to send emails – this must be one of the following:

  • Mailjet
  • Mailgun
  • SendGrid
• the sender email address – for example jane.doe@companyname.com

Notes: 
–The sender address must use a domain that is verified and authenticated by your chosen email provider.
– 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.

• the name associated with the sender address – for example, Jane Doe
• the Reply To address – for example, customerservice@comanyname.com

Note: This is required only if you want users to be able to reply to emails.

• the name associated with the Reply To address – for example Customer Service
• the API key of the email provider 
• the secret key of the email provider (required for Mailjet only)

The AODocs Support team will perform the required configuration so you can use the API to customize the sender domain as defined below. 

Customize 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.

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.

Customize 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.

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.