PUT - Add Catch-All Address

Purpose

This API is used to designate an email address as the catch-all account for your organization.

A catch-all email account is a user mailbox or group mailbox that captures emails sent to any invalid email addresses of the domain. When configured, the emails sent to any email address related to the domain will not be bounced back. Even the emails addressed to 'non-existing' or 'invalid' email addresses of the domain will be delivered to the catch-all account configured. 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 catch-all 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 addCatchAllAddress.
  • catchAllAddress* string
    • This parameter specify the email address to be used as a catch-all account.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

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

Sample Response

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