Title: Activate Catch-all Account Using the API  
PrimaryCategory: Business &amp; Enterprise Email  
Type: Procedural  
Tags: catch-all, api, activate, email, domain, order-id  
Source UI Terms: auth-userid, api-key, order-id, catchall-email  
Source Reference: Activate Catch-all Account Using the API  

---

Prerequisites:  
- You must have authentication credentials: auth-userid and api-key.  
- You need the order-id corresponding to your domain registration, email hosting, or related service order.  
- The catchall-email address must be part of the domain associated with the order-id.  

Steps:  
1) Prepare a POST API request to the following endpoint:  
   `https://test.httpapi.com/api/mail/domain/activate-catchall.json`  
2) Include the following parameters in the request query string:  
   - `auth-userid` (Integer, required): Your authentication user ID  
   - `api-key` (String, required): Your API key for authentication  
   - `order-id` (Integer, required): The order ID of the domain or service order  
   - `catchall-email` (String, required): The email address within the domain for catch-all activation  
3) Send the POST request to activate the catch-all email account.  
4) Check the API response. A successful activation returns the status `&quot;SUCCESS&quot;`.  

Summary:  
To activate a catch-all email account using the API, send a POST request to the designated endpoint with your authentication details, order ID, and the target catch-all email address. A successful response returns &quot;SUCCESS.&quot;  

Evaluation Pairs:  
Q: What parameters are required to activate a catch-all account using the API?  
A: You must provide auth-userid, api-key, order-id, and catchall-email, all marked as required.  

Q: What HTTP method should be used for activating a catch-all account?  
A: Use the POST method.  

Q: What response indicates that the catch-all account activation was successful?  
A: The API returns &quot;SUCCESS&quot; as the status in response to a successful activation.

<p>When you want to activate a catch-all email account using the API. This article explains the required parameters and API request format for catch-all account activation.</p>
<div class="region region-content">
<div class="hidden"> </div>
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Activate Catch-all Account</span></h1>
<div id="toc" style="display: block;">
<div id="toc_content">
<p> </p>
</div>
</div>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2><a name="heading_0"></a>Description</h2>
<p>Activates catch-all account.</p>
<h2><a name="heading_1"></a>Parameters</h2>
<table class="codetable"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">order-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order</td></tr><tr><td colspan="1" rowspan="1">catchall-email</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Email address which is a part of the domain of the order-id</td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>POST</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code><br> https://test.httpapi.com/api/mail/domain/activate-catchall.json?auth-userid=0&amp;api-key=key&amp;order-id=0&amp;catchall-email=user1@domainname.com<br> </code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns &quot;SUCCESS&quot; as the status if catch-all account activated successfully.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to activate a catch-all email account using the API. This article explains the required parameters and API request format for catch-all account activation.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
order-id	Integer	Required	Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
catchall-email	String	Required	Email address which is a part of the domain of the order-id