Use the API to define a prefix 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.

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:

Important:
– You can configure this custom configuration by API only. It isn't available in the administration interface.
– Custom configurations at the library level take precedence over those set at the domain level. For example, if you set the prefix as contracts at the domain level and as invoices for one library, all the libraries on the domain will send notifications with the prefix contracts except the one in which the flag is defined as invoices.

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


Define a prefix 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 flag name: email_sender_noreply_address_prefix.

4. In the Request body field, enter the prefix you want to use.

Note: By default, email notifications start with the word notifications. Learn more: List of email notifications sent by AODocs. The prefix you enter will replace the word notifications. The rest of the text before the @ sign remains unchanged.

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

image02.png


Define a prefix 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 flag name: email_sender_noreply_address_prefix.

5. In the Request body field, enter the prefix you want to use.

Note: By default, email notifications start with the word notifications. Learn more: List of email notifications sent by AODocs. The prefix you enter will replace the word notifications. The rest of the text before the @ sign remains unchanged.

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

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