Sign in

v1

latestSwagger 2.02026-07-136573327.3 KB
Domains

Update privacy email forwarding settings to determine how emails are delivered

patch/v2/customers/{customerId}/domains/{domain}/privacy/forwarding

Path parameters

customerIdstring required

The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id.

domainstring required

Domain name whose details are to be retrieved

Headers

X-Request-Idstring

A client provided identifier for tracking this request.

Request body

privateEmailType'DEFAULT' | 'RANDOM' required

The private email type<br/><ul><li><strong style='margin-left: 12px;'>DEFAULT</strong> - Use default email address (example: domainname.com@domainsbyproxy.com)</li><li><strong style='margin-left: 12px;'>RANDOM</strong> - Randomize email address, we’ll create a private email address using random characters to further protect you from unwanted spam. (5f9e6c9368a64565bf2b2cf8db91aea4@domainsbyproxy.com)</li></ul>

forwardingEmailstring

The email that it forwards to

emailPreference'EMAIL_FILTER' | 'EMAIL_SEND_ALL' | 'EMAIL_SEND_NONE' required

The email forwarding preference for the domain<br/><ul><li><strong style='margin-left: 12px;'>EMAIL_FILTER</strong> - Filter for spam and forward email.</li><li><strong style='margin-left: 12px;'>EMAIL_SEND_ALL</strong> - Forward all email.</li><li><strong style='margin-left: 12px;'>EMAIL_SEND_NONE</strong> - Don't forward email.</li></ul>

Response

Request Accepted. You may use GET /v2/customers/{customerId}/domains/{domain}/actions/PRIVACY_FORWARDING_UPDATE to poll status