PUT - Add Notification Address

Purpose

This API is used to designate an email address as the notification address for your organization.

The notification address is the email address to which certain notification emails are sent. These emails include: 

  • Group email delivery failure notification, if there is no moderator for the group. 
  • Email routing delivery failure or email routing disabled notifications in case of repeated failures. 
  • MX Record-related warning notifications for the domain. 
  • Mail storage-related notifications for the domain.

To learn more, click here.

OAuth Scope

Use the scope

ZohoMail.organization.domains.ALL (or) ZohoMail.organization.domains.UPDATE

to generate the Authtoken.

ALL - Grants full access to domains.

UPDATE - Grants update access to domains.

Request URL

Method: PUT

https://mail.zoho.com/api/organization/{zoid}/domains/{domainName}

Path Parameters

  • zoid* long
    • This parameter specifies the unique Zoho Organization Identifier for the organization.
    • This parameter can be fetched from Get Organization Details API.
  • domainName* string
    • This parameter specifies the domain name for which the notification email address is added.

 

Request Body(JSON Object)

  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as addNotificationAddress.
  • notificationAddress* string
    • This parameter specifies the email address that should be used as a notification address for the specified domain.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl " https://mail.zoho.com/api/organization/1234567890/domains/zylker.com" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****" \
-d '{ 
"mode":"addNotificationAddress",  
"notificationAddress":"notifications@zylker.com" 
}'

Sample Response

Copied{
   "status": {
       "code": 200,
       "description": "success"
   }
}