privacy_forwarding_v2
GoDaddy Domains v2 API, scoped to a customer: customer_id is resolved from the GODADDY_CUSTOMER_ID environment variable when set, otherwise it is a required parameter (a WHERE value always wins). Accepts a Personal Access Token (Bearer) or a classic sso-key credential.
Overview
| Name | privacy_forwarding_v2 |
| Type | Resource |
| Id | godaddy.domains.privacy_forwarding_v2 |
Fields
The following fields are returned by SELECT queries:
- get
Request was successful
| Name | Datatype | Description |
|---|---|---|
email_preference | string | The email forwarding preference for the domain - EMAIL_FILTER — Filter for spam and forward email. - EMAIL_SEND_ALL — Forward all email. - EMAIL_SEND_NONE — Don't forward email. (EMAIL_FILTER, EMAIL_SEND_ALL, EMAIL_SEND_NONE) (wire: emailPreference) |
forwarding_email | string | The email that it forwards to (wire: forwardingEmail) |
private_email | string | The private email (wire: privateEmail) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain, customer_id | x_request_id | Returns the current privacy email forwarding configuration including target address and forwarding mode. |
update | update | domain, private_email_type, email_preference, customer_id | x_request_id | Updates privacy email forwarding settings. Only fields included in the request are modified. Returns 202 - poll the actions endpoint for completion. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
customer_id | string (uuid) | GoDaddy customer identifier (UUID, not the numeric shopper number). Resolved from the GODADDY_CUSTOMER_ID environment variable when it is set (server variable, x-stackQL-envVar); otherwise required on every method of this resource. A WHERE value always takes precedence over the environment. API resellers acting on behalf of a subaccount pass the subaccount customer identifier. |
domain | string | Domain name whose details are to be retrieved |
x_request_id | string | A client provided identifier for tracking this request. (wire: X-Request-Id) |
SELECT examples
- get
Returns the current privacy email forwarding configuration including target address and forwarding mode.
SELECT
email_preference,
forwarding_email,
private_email
FROM godaddy.domains.privacy_forwarding_v2
WHERE domain = '{{ domain }}' -- required
AND customer_id = '{{ customer_id }}' -- required unless GODADDY_CUSTOMER_ID is set
AND x_request_id = '{{ x_request_id }}'
;
UPDATE examples
- update
Updates privacy email forwarding settings. Only fields included in the request are modified. Returns 202 - poll the actions endpoint for completion.
UPDATE godaddy.domains.privacy_forwarding_v2
SET
private_email_type = '{{ private_email_type }}',
forwarding_email = '{{ forwarding_email }}',
email_preference = '{{ email_preference }}'
WHERE
domain = '{{ domain }}' --required
AND private_email_type = '{{ private_email_type }}' --required
AND email_preference = '{{ email_preference }}' --required
AND x_request_id = '{{ x_request_id}}';